From 8dd7a433217f86cdbe296ac4386fea72248e6f9b Mon Sep 17 00:00:00 2001 From: Peter Milchev Date: Wed, 12 May 2021 12:09:26 +0300 Subject: [PATCH] docs(api): Update Server API for R2 2021 release --- .../Telerik.Web.UI.Gantt/TasksTooltip.md | 26 ++ .../TasksTooltipConverter.md | 41 ++ .../GanttToolbarItemConverter.md | 41 ++ api/server/Telerik.Web.UI/RadDrawer.md | 4 + api/server/Telerik.Web.UI/RadSwitch.md | 380 ++++++++++++++++++ api/server/Telerik.Web.UI/RadTimeline.md | 4 + .../Telerik.Web.UI/SwitchToggleState.md | 26 ++ .../SwitchToggleStatesSettings.md | 26 ++ 8 files changed, 548 insertions(+) create mode 100644 api/server/Telerik.Web.UI.Gantt/TasksTooltip.md create mode 100644 api/server/Telerik.Web.UI.Gantt/TasksTooltipConverter.md create mode 100644 api/server/Telerik.Web.UI/GanttToolbarItemConverter.md create mode 100644 api/server/Telerik.Web.UI/RadSwitch.md create mode 100644 api/server/Telerik.Web.UI/SwitchToggleState.md create mode 100644 api/server/Telerik.Web.UI/SwitchToggleStatesSettings.md diff --git a/api/server/Telerik.Web.UI.Gantt/TasksTooltip.md b/api/server/Telerik.Web.UI.Gantt/TasksTooltip.md new file mode 100644 index 0000000000..b09ac94f8c --- /dev/null +++ b/api/server/Telerik.Web.UI.Gantt/TasksTooltip.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.Gantt.TasksTooltip +page_title: Telerik.Web.UI.Gantt.TasksTooltip +description: Telerik.Web.UI.Gantt.TasksTooltip +--- + +# Telerik.Web.UI.Gantt.TasksTooltip + +The default Kendo UI Tooltip options for all marker layers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.Gantt.TasksTooltip : IDefaultCheck + +## Properties + +### ClientTemplate `String` + +The template which renders the tooltip.The fields which can be used in the template are: task - the gantt task, for which the template is shown. + +### Visible `Boolean` + +If set to false the gantt will not display the task tooltip. By default the task tooltip is displayed. + diff --git a/api/server/Telerik.Web.UI.Gantt/TasksTooltipConverter.md b/api/server/Telerik.Web.UI.Gantt/TasksTooltipConverter.md new file mode 100644 index 0000000000..12343ac358 --- /dev/null +++ b/api/server/Telerik.Web.UI.Gantt/TasksTooltipConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.Gantt.TasksTooltipConverter +page_title: Telerik.Web.UI.Gantt.TasksTooltipConverter +description: Telerik.Web.UI.Gantt.TasksTooltipConverter +--- + +# Telerik.Web.UI.Gantt.TasksTooltipConverter + +Serialization JS converter class for Tooltip + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.Gantt.TasksTooltipConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI/GanttToolbarItemConverter.md b/api/server/Telerik.Web.UI/GanttToolbarItemConverter.md new file mode 100644 index 0000000000..78a109c378 --- /dev/null +++ b/api/server/Telerik.Web.UI/GanttToolbarItemConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.GanttToolbarItemConverter +page_title: Telerik.Web.UI.GanttToolbarItemConverter +description: Telerik.Web.UI.GanttToolbarItemConverter +--- + +# Telerik.Web.UI.GanttToolbarItemConverter + +Serialization JS converter class for GanttToolbarItem + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.GanttToolbarItemConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI/RadDrawer.md b/api/server/Telerik.Web.UI/RadDrawer.md index 0d93ce01fb..0f06ef2acc 100644 --- a/api/server/Telerik.Web.UI/RadDrawer.md +++ b/api/server/Telerik.Web.UI/RadDrawer.md @@ -107,6 +107,10 @@ Enables or configures the mini mode for the Kendo UI Drawer. This is a compact v Determines how the Kendo UI Drawer will interact with the associated content. The default one (overlay) will simply overlap the associated content with overlay effect. On the other hand "push" mode will show the drawer next to associated cotent. The associated content will shrink its content. +### Navigatable `Boolean` + +Navigate the widget using the keyboard. By default keyboard navigation is disabled. + ### Position `DrawerPositionType` The position of the drawer. Can be left (default) or right. diff --git a/api/server/Telerik.Web.UI/RadSwitch.md b/api/server/Telerik.Web.UI/RadSwitch.md new file mode 100644 index 0000000000..4ad1ac76fd --- /dev/null +++ b/api/server/Telerik.Web.UI/RadSwitch.md @@ -0,0 +1,380 @@ +--- +title: Telerik.Web.UI.RadSwitch +page_title: Telerik.Web.UI.RadSwitch +description: Telerik.Web.UI.RadSwitch +--- + +# Telerik.Web.UI.RadSwitch + +RadCheckBox leverages the functionality of the standard checkbox. + +## Inheritance Hierarchy + +* System.Object +* System.Web.UI.Control +* System.Web.UI.WebControls.WebControl +* Telerik.Web.UI.RadWebControl : IControl, IControlResolver, IPostBackDataHandler, IScriptControl, ISkinnableControl +* Telerik.Web.UI.ButtonBase.RadButtonBase : INamingContainer +* Telerik.Web.UI.ButtonBase.PostBackButtonBase : IButtonControl, IPostBackEventHandler +* Telerik.Web.UI.ButtonBase.CheckableButton : ICheckableButton +* Telerik.Web.UI.RadSwitch : IJavaScriptConverterProvider + +## Properties + +### AccessKey `String` + +Gets or sets the accessKey of the Button control. + +### AriaSettings `WaiAriaSettings` + +Gets the object that controls the Wai-Aria settings applied on the control's element. + +### AutoPostBack `Boolean` + +Gets or sets a bool value indicating whether the Button control automatically posts back to the server when clicked. + +### CausesValidation `Boolean` + +Gets or sets a value indicating whether validation is performed when the Button control is clicked. + +### Checked `Nullable`1` + +Gets or sets a value indicating whether the button is checked. + +### ClientIDMode `ClientIDMode` + +This property is overridden in order to support controls which implement INamingContainer. + The default value is changed to "AutoID". + +### CommandArgument `String` + +Gets or sets an optional parameter passed to the Command event along with the associated CommandName. + +### CommandName `String` + +Gets or sets the command name associated with the Button control that is passed to the Command event. + +### ConfirmSettings `RadButtonConfirmSettings` + +Gets the object that controls the built-in confirmation dialog properties. + +### CssClass `String` + +Gets or sets the CSS class rendered by the Button control on the client. + +### CssClassFormatString `String` + +The CssClass property will now be used instead of the former Skin + and will be modified in AddAttributesToRender() + +### CurrentToggleState `SwitchToggleState` + +Gets the On or Off toggle state based on the Checked property. + +### DisabledCssClass `String` + +Gets or sets the CSS class applied to the Button control when it is in a disabled state. + +### EnableAjaxSkinRendering `String` + +Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests + +#### Remarks +If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax. + +### EnableAriaSupport `Boolean` + +When set to true enables support for WAI-ARIA + +### EnableEmbeddedBaseStylesheet `Boolean` + +Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not. + +#### Remarks +If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand. + +### EnableEmbeddedScripts `Boolean` + +Gets or sets the value, indicating whether to render script references to the embedded scripts or not. + +#### Remarks +If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand. + +### EnableEmbeddedSkins `String` + +Gets or sets the value, indicating whether to render links to the embedded skins or not. + +#### Remarks +If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand. + +### EnableRippleEffect `Boolean` + +Returns true if ripple effect should be added + +### Height `Unit` + +Gets or sets the height of the Button control. + +### HoveredCssClass `String` + +Gets or sets the CSS class applied to the Button control when the mouse pointer is over the control. + +### IsSkinSet `String` + +For internal use. + +### OnClientCheckedChanged `Nullable`1` + +Gets or sets the name of the JavaScript function that will be called after the button has been checked. + +### OnClientCheckedChanging `Nullable`1` + +Gets or sets the name of the JavaScript function that will be called when the button is about to be checked. + +### OnClientClicked `String` + +Gets or sets the name of the JavaScript function that will be called when the Button is clicked, after the OnClientClicking event. + +### OnClientClicking `String` + +Gets or sets the name of the JavaScript function that will be called when the Button is clicked. The event is cancelable. + +### OnClientLoad `String` + +Gets or sets the name of the JavaScript function that will be called when the Button is loaded on the page. + +### OnClientMouseOut `String` + +Gets or sets the name of the JavaScript function that will be called when the mouse pointer leaves the Button. + +### OnClientMouseOver `String` + +Gets or sets the name of the JavaScript function that will be called when the mouse pointer hovers over the Button. + +### OriginalEnabled `Boolean` + +The Enabled property is reset in AddAttributesToRender in order + to avoid setting disabled attribute in the control tag (this is + the default behavior). This property has the real value of the + Enabled property in that moment. + +### PostBackUrl `String` + +Gets or sets the URL of the page to post to from the current page when the Button control is clicked. + +### PressedCssClass `String` + +Gets or sets the CSS class applied to the Button control when the control is pressed. + +### RegisterWithScriptManager `Boolean` + +Gets or sets the value, indicating whether to register with the ScriptManager control on the page. + +#### Remarks +If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods. + +### RenderMode `RenderMode` + +Specifies the rendering mode of the control. Setting the mode to Lightweight will yield + HTML 5/CSS 3 html and css. + +#### Remarks +Lightweight rendering mode might change the outlook of the component in some older browsers + that don't support CSS3/HTML5. + +### ResolvedRenderMode `RenderMode` + +Returns resolved RenderMode should the original value was Auto + +### RuntimeSkin `String` + +Gets the real skin name for the control user interface. If Skin is not set, returns + "Default", otherwise returns Skin. + +### SingleClick `Boolean` + +Gets or sets a bool value indicating whether the Button control will be immediately disabled after the user has clicks it. (i.e. enables/disables "Single Click" functionality) + +### SingleClickText `String` + +The Text and SingleClickText property is not applicable for RadSwitch scenario. Please use the ToggleState's ToggleStateOn and ToggleStateOff settings to control the text in the On/Off states or an external label control to provide description for the Switch control. + +### SingleClickText `Boolean` + +Gets or sets the text displayed in the Button control after the button is being clicked and disabled. (i.e. the text used for the 'Single Click' functionality) + +### Skin `String` + +Gets or sets the skin name for the control user interface. + +#### Remarks +If this property is not set, the control will render using the skin named "Default". + If EnableEmbeddedSkins is set to false, the control will not render skin. + +### SupportsRenderingMode `Boolean` + +Gets or RenderingMode support + +### TabIndex `Int16` + +Gets or sets the TabIndex of the Button control. + +### Text `String` + +The Text and SingleClickText property is not applicable for RadSwitch scenario. Please use the ToggleState's ToggleStateOn and ToggleStateOff settings to control the text in the On/Off states or an external label control to provide description for the Switch control. + +### Text `String` + +Gets or sets the text displayed in the Button control. + +### ToggleStates `SwitchToggleStatesSettings` + +Gets the object that controls the settings of the toggle states. + +### ToolTip `String` + +Gets or sets the text that will be displayed in the tooltip of the Button control when it is hovered. + +### UseSubmitBehavior `Boolean` + +Gets or sets a value indicating whether the Button control uses the client browser's submit mechanism or the ASP.NET postback mechanism. + +### ValidationGroup `String` + +Gets or sets the group of controls for which the Button control causes validation when it posts back to the server. + +### Value `String` + +Gets or sets an optional Value of the Button control. + +### Width `Unit` + +Gets or sets the width of the Button control. + +## Methods + +### AddAttributesToRender + +Adds the attributes of the RadButton control to the output stream for rendering on the client. + +#### Parameters + +#### writer `System.Web.UI.HtmlTextWriter` + +An HtmlTextWriter that contains the output stream to render on the client. + +#### Returns + +`System.Void` + +### ApplyConditionalRendering + +Use this from RenderContents of the inheritor + +#### Returns + +`System.Void` + +### ControlPreRender + +Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason + +#### Returns + +`System.Void` + +### GetEmbeddedSkinNames + +Returns the names of all embedded skins. Used by Telerik.Web.Examples. + +#### Returns + +`System.Collections.Generic.List`1` + +### GetPostbackEventReference + +Creates a PostBackOptions object that represents the RadButton control's postback behavior, and returns the client script + generated as a result of the PostBackOptions. + +#### Returns + +`System.String` The client script that represents the RadButton control's PostBackOptions. + +### GetPostBackOptions + +Creates a PostBackOptions object that represents the RadButton control's postback behavior. + +#### Returns + +`System.Web.UI.PostBackOptions` A PostBackOptions that represents the RadButton control's postback behavior. + +### LoadClientState + +Loads the client state data + +#### Parameters + +#### clientState `System.Collections.Generic.Dictionary{System.String,System.Object}` + +#### Returns + +`System.Void` + +### LoadPostData + +Executed when post data is loaded from the request + +#### Parameters + +#### postDataKey `System.String` + +#### postCollection `System.Collections.Specialized.NameValueCollection` + +#### Returns + +`System.Boolean` + +### OnCheckedChanged + +Raises the CheckedChanged event of the button. + +#### Parameters + +#### e `System.EventArgs` + +#### Returns + +`System.Void` + +### RaisePostDataChangedEvent + +Executed when post data changes should invoke a changed event + +#### Returns + +`System.Void` + +### RegisterCssReferences + +Registers the CSS references + +#### Returns + +`System.Void` + +### RegisterScriptControl + +Registers the control with the ScriptManager + +#### Returns + +`System.Void` + +### SaveClientState + +Saves the client state data + +#### Returns + +`System.String` + diff --git a/api/server/Telerik.Web.UI/RadTimeline.md b/api/server/Telerik.Web.UI/RadTimeline.md index 55d75ff570..f99a3dadae 100644 --- a/api/server/Telerik.Web.UI/RadTimeline.md +++ b/api/server/Telerik.Web.UI/RadTimeline.md @@ -127,6 +127,10 @@ Sets specific width for the event in vertical mode. For internal use. +### Navigatable `Boolean` + +Navigate the widget using the keyboard. Setting it to true will enable the keyaboard navigation for the component. + ### ODataDataSourceID `String` Gets or sets the ODataDataSource used for data binding. diff --git a/api/server/Telerik.Web.UI/SwitchToggleState.md b/api/server/Telerik.Web.UI/SwitchToggleState.md new file mode 100644 index 0000000000..30ac7b169c --- /dev/null +++ b/api/server/Telerik.Web.UI/SwitchToggleState.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.SwitchToggleState +page_title: Telerik.Web.UI.SwitchToggleState +description: Telerik.Web.UI.SwitchToggleState +--- + +# Telerik.Web.UI.SwitchToggleState + +This class represents a single Telerik.Web.UI.RadButton ToggleState when the RadButton control is used as custom toggle button. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.SwitchToggleState + +## Properties + +### Text `String` + +Gets or sets the text displayed in the Toggle state label. + +### Value `String` + +Gets or sets optional Value. + diff --git a/api/server/Telerik.Web.UI/SwitchToggleStatesSettings.md b/api/server/Telerik.Web.UI/SwitchToggleStatesSettings.md new file mode 100644 index 0000000000..0e497a6178 --- /dev/null +++ b/api/server/Telerik.Web.UI/SwitchToggleStatesSettings.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.SwitchToggleStatesSettings +page_title: Telerik.Web.UI.SwitchToggleStatesSettings +description: Telerik.Web.UI.SwitchToggleStatesSettings +--- + +# Telerik.Web.UI.SwitchToggleStatesSettings + +Manages the SwitchToggleStatesSettings of the Switch control. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.SwitchToggleStatesSettings + +## Properties + +### ToggleStateOff `SwitchToggleState` + +Configure the ON/Checked toggle state settings. + +### ToggleStateOn `SwitchToggleState` + +Configure the ON/Checked toggle state settings. +