diff --git a/api/server/Telerik.Web.UI/AlignOffset.md b/api/server/Telerik.Web.UI/AlignOffset.md new file mode 100644 index 0000000000..aa10820ec1 --- /dev/null +++ b/api/server/Telerik.Web.UI/AlignOffset.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.AlignOffset +page_title: Telerik.Web.UI.AlignOffset +description: Telerik.Web.UI.AlignOffset +--- + +# Telerik.Web.UI.AlignOffset + +Specifies the horizontal and vertical offset of the FloatingActionButton. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.AlignOffset : IDefaultCheck + +## Properties + +### X `Double` + +Specifies the initial horizontal offset of the FloatingActionButton. Numeric values are treated as pixels. String values can specify pixels, percentages, ems, or other valid values. + +### Y `Double` + +Specifies the initial vertical offset of the FloatingActionButton. Numeric values are treated as pixels. String values can specify pixels, percentages, ems or other valid values. + diff --git a/api/server/Telerik.Web.UI/AlignOffsetConverter.md b/api/server/Telerik.Web.UI/AlignOffsetConverter.md new file mode 100644 index 0000000000..8ec5a027c8 --- /dev/null +++ b/api/server/Telerik.Web.UI/AlignOffsetConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.AlignOffsetConverter +page_title: Telerik.Web.UI.AlignOffsetConverter +description: Telerik.Web.UI.AlignOffsetConverter +--- + +# Telerik.Web.UI.AlignOffsetConverter + +Serialization JS converter class for AlignOffset + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.AlignOffsetConverter + +## 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/FloatingActionButtonClientEvents.md b/api/server/Telerik.Web.UI/FloatingActionButtonClientEvents.md new file mode 100644 index 0000000000..9f73fd9fa5 --- /dev/null +++ b/api/server/Telerik.Web.UI/FloatingActionButtonClientEvents.md @@ -0,0 +1,38 @@ +--- +title: Telerik.Web.UI.FloatingActionButtonClientEvents +page_title: Telerik.Web.UI.FloatingActionButtonClientEvents +description: Telerik.Web.UI.FloatingActionButtonClientEvents +--- + +# Telerik.Web.UI.FloatingActionButtonClientEvents + +Defines the client events handlers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.FloatingActionButtonClientEvents : IDefaultCheck + +## Properties + +### OnClick `String` + +Fires when the user clicks on a the FloatingActionButton.**Note: when using items configuration, clicking on the FloatingActionButton will open the speed-dial list popup. + +### OnCollapse `String` + +Fires when the speed-dial popup is closed and its animation is finished.**Note: this event is triggered only when using items configuration. + +### OnExpand `String` + +Fires when the speed-dial popup is opened and its animation is finished.**Note: this event is triggered only when using items configuration. + +### OnInitialize `String` + +Fired when the FloatingActionButton control is initialized. + +### OnLoad `String` + +Fired when the FloatingActionButton control is loaded on the page. + diff --git a/api/server/Telerik.Web.UI/FloatingActionButtonItem.md b/api/server/Telerik.Web.UI/FloatingActionButtonItem.md new file mode 100644 index 0000000000..bb86daaf74 --- /dev/null +++ b/api/server/Telerik.Web.UI/FloatingActionButtonItem.md @@ -0,0 +1,46 @@ +--- +title: Telerik.Web.UI.FloatingActionButtonItem +page_title: Telerik.Web.UI.FloatingActionButtonItem +description: Telerik.Web.UI.FloatingActionButtonItem +--- + +# Telerik.Web.UI.FloatingActionButtonItem + +Specifies the speed-dial items that will be rendered in a popup container anchored to the FloatingActionButton.**Note: when using the items configuration, clicking on the FloatingActionButton will open the popup containing the speed-dial list. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.FloatingActionButtonItem + +## Properties + +### ClientTemplate `String` + +Specifies the template used to render the contents of the speed-dial item.The fields which can be used inside the template are: text String - the label of the item (if configured). or icon String - the icon specified for this step (if configured).. + +### CssClass `String` + +Specifies a set of CSS classes for the speed-dial item. + +### Enabled `Boolean` + +Specifies whether the Item is enabled or not. By default all items are enabled. + +### Icon `String` + +Specifies the name for an existing icon in a Kendo UI theme that is rendered in the speed-dial item.See the Web Font Icons help article for more details on Kendo UI icons. + +### Label `String` + +Specifies the label for the speed-dial item. + +### OnClientClicked `String` + +Specifies the click event handler of the speed-dial item. + +### Title `String` + +Specifies the label for the speed-dial item that will be read by assistive technologies. + diff --git a/api/server/Telerik.Web.UI/FloatingActionButtonItemConverter.md b/api/server/Telerik.Web.UI/FloatingActionButtonItemConverter.md new file mode 100644 index 0000000000..c5f045d574 --- /dev/null +++ b/api/server/Telerik.Web.UI/FloatingActionButtonItemConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.FloatingActionButtonItemConverter +page_title: Telerik.Web.UI.FloatingActionButtonItemConverter +description: Telerik.Web.UI.FloatingActionButtonItemConverter +--- + +# Telerik.Web.UI.FloatingActionButtonItemConverter + +Serialization JS converter class for FloatingActionButtonItem + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.FloatingActionButtonItemConverter + +## 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/RadFloatingActionButton.md b/api/server/Telerik.Web.UI/RadFloatingActionButton.md new file mode 100644 index 0000000000..f7aa453566 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadFloatingActionButton.md @@ -0,0 +1,221 @@ +--- +title: Telerik.Web.UI.RadFloatingActionButton +page_title: Telerik.Web.UI.RadFloatingActionButton +description: Telerik.Web.UI.RadFloatingActionButton +--- + +# Telerik.Web.UI.RadFloatingActionButton + +## 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.RadFloatingActionButton + +## Properties + +### Align `RadFloatingActionButtonAlign` + +Specifies position of the FloatingActionButton relative to its container. Valid position options are: "top start": positions the button at top left corner of the container.; "top center": positions the button at top center of the container.; "top end": positions the button at top right corner of the container.; "middle start": positions the button at middle left of the container.; "middle end": positions the button at middle right of the container.; "bottom start": positions the button at bottom left corner of the container.; "bottom center": positions the button at top center of the container. or "bottom end": positions the button at bottom right corner of the container.. works in conjunction with positionMode and alignOffset.**Note: when using align, make sure the FloatingActionButton container has css position other than "static" and allows overflow content. + +### AlignOffsetSettings `RadFloatingActionButtonAlign` + +Specifies the horizontal and vertical offset of the FloatingActionButton. + +### ClientEvents `FloatingActionButtonClientEvents` + +Defines the client events handlers. + +### ClientIDMode `ClientIDMode` + +This property is overridden in order to support controls which implement INamingContainer. + The default value is changed to "AutoID". + +### CssClassFormatString `String` + +The CssClass property will now be used instead of the former Skin + and will be modified in AddAttributesToRender() + +### 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. + +### 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 + +### Icon `String` + +Specifies the name for an existing icon in a Kendo UI theme that is rendered in the FloatingActionButton.See the Web Font Icons help article for more details on Kendo UI icons. + +### IsSkinSet `String` + +For internal use. + +### Items `FloatingActionButtonItemsCollection` + +Specifies the speed-dial items that will be rendered in a popup container anchored to the FloatingActionButton.**Note: when using the items configuration, clicking on the FloatingActionButton will open the popup containing the speed-dial list. + +### PositionMode `RadFloatingActionButtonPositionMode` + +Specifies CSS position of the FloatingActionButton in the document. Valid options are: "absolute": positions the button relative to the nearest positioned ancestor . or "fixed": positions the button relative to the viewport.. + +### 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. + +### Shape `RadFloatingActionButtonShape` + +Specifies the shape of the FloatingActionButton. "rectangle", "pill" or "square". + +### Size `RadFloatingActionButtonSize` + +Specifies the size of the FloatingActionButton. Valid options are "small", "medium", "large" and null. + +### 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. + +### Text `String` + +Specifies the text of the FloatingActionButton. Default is empty string. + +### ThemeColor `RadFloatingActionButtonThemeColor` + +Specifies the theme color of the FloatingActionButton. Valid options are "primary", "secondary", "tertiary", "info", "success", "warning", "error". + +## Methods + +### 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` + +### 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` + +### 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/RadFloatingActionButtonConverter.md b/api/server/Telerik.Web.UI/RadFloatingActionButtonConverter.md new file mode 100644 index 0000000000..a691c02db8 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadFloatingActionButtonConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.RadFloatingActionButtonConverter +page_title: Telerik.Web.UI.RadFloatingActionButtonConverter +description: Telerik.Web.UI.RadFloatingActionButtonConverter +--- + +# Telerik.Web.UI.RadFloatingActionButtonConverter + +Serialization JS converter class for RadFloatingActionButton + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.RadFloatingActionButtonConverter + +## 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` +