Skip to content

Commit 821a70a

Browse files
Signature documentation (#425)
* docs(signature): add Signature documentation * docs(signature): add server-side api articles * docs(signature): fix slug * docs(signature): fix links and repetitive words
1 parent 78a2073 commit 821a70a

File tree

15 files changed

+773
-0
lines changed

15 files changed

+773
-0
lines changed

_config.yml

+4
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,9 @@ navigation:
413413
"controls/searchbox":
414414
title: "SearchBox"
415415
position: 1
416+
"controls/signature":
417+
title: "Signature"
418+
position: 1
416419
"controls/sitemap":
417420
title: "Sitemap"
418421
position: 1
@@ -1990,6 +1993,7 @@ intro_columns:
19901993
"DropDownList": "dropdownlist/overview"
19911994
"DropDownTree": "dropdowntree/overview"
19921995
"Editor": "editor/overview"
1996+
"Signature": "signature/overview"
19931997
"Image Editor": "imageeditor/overview"
19941998
"InputManager": "radinputmanager/overview"
19951999
"Label": "label/overview"

api/server/Telerik.Web.UI/RadDropDownList.md

+4
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,10 @@ The CssClass property will now be used instead of the former Skin
9393

9494
Gets or sets a message when there is no selected item in the DropDownList.
9595

96+
### DropDownAutoWidth `RadDropDownListDropDownAutoWidth`
97+
98+
Gets or sets whether to enable/disable the RadDropDownList drop down auto width.
99+
96100
### DropDownHeight `Unit`
97101

98102
Gets or sets the height of the dropdown in pixels.
+241
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
---
2+
title: Telerik.Web.UI.RadSignature
3+
page_title: Telerik.Web.UI.RadSignature
4+
description: Telerik.Web.UI.RadSignature
5+
---
6+
7+
# Telerik.Web.UI.RadSignature
8+
9+
## Inheritance Hierarchy
10+
11+
* System.Object
12+
* System.Web.UI.Control
13+
* System.Web.UI.WebControls.WebControl
14+
* Telerik.Web.UI.RadWebControl : IControl, IControlResolver, IPostBackDataHandler, IScriptControl, ISkinnableControl
15+
* Telerik.Web.UI.RadSignature
16+
17+
## Properties
18+
19+
### BackColor `Color`
20+
21+
Gets or sets the background color of the signature.
22+
23+
### ClientEvents `SignatureClientEvents`
24+
25+
Defines the client events handlers.
26+
27+
### ClientIDMode `ClientIDMode`
28+
29+
This property is overridden in order to support controls which implement INamingContainer.
30+
The default value is changed to "AutoID".
31+
32+
### CssClassFormatString `String`
33+
34+
The CssClass property will now be used instead of the former Skin
35+
and will be modified in AddAttributesToRender()
36+
37+
### Enable `Boolean`
38+
39+
If set to false, the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input.
40+
41+
### EnableAjaxSkinRendering `String`
42+
43+
Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests
44+
45+
#### Remarks
46+
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.
47+
48+
### EnableEmbeddedBaseStylesheet `Boolean`
49+
50+
Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not.
51+
52+
#### Remarks
53+
If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand.
54+
55+
### EnableEmbeddedScripts `Boolean`
56+
57+
Gets or sets the value, indicating whether to render script references to the embedded scripts or not.
58+
59+
#### Remarks
60+
If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand.
61+
62+
### EnableEmbeddedSkins `String`
63+
64+
Gets or sets the value, indicating whether to render links to the embedded skins or not.
65+
66+
#### Remarks
67+
If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand.
68+
69+
### EnableRippleEffect `Boolean`
70+
71+
Returns true if ripple effect should be added
72+
73+
### FillMode `RadSignatureFillMode`
74+
75+
Sets a value controlling how the color is applied. Can also be set to the following string values: "solid"; "flat"; "outline" or "none".
76+
77+
### ForeColor `Color`
78+
79+
The stroke color of the signature.
80+
81+
### HideLine `Boolean`
82+
83+
A value indicating whether the dotted line should be displayed in the background.
84+
85+
### IsSkinSet `String`
86+
87+
For internal use.
88+
89+
### Label `String`
90+
91+
Specifies the label that will be rendered on the k-signature-canvas element of the component with the aria-label attribute.
92+
93+
### Maximizable `Boolean`
94+
95+
A value indicating whether the component can be maximized
96+
97+
### PopupScale `Double`
98+
99+
Defines a value indicating the scaling size of the popup signature pad
100+
101+
### ReadOnly `Boolean`
102+
103+
If set to true, the widget will be readonly and will not allow user input. The widget is not readonly by default and allows user input.
104+
105+
### RegisterWithScriptManager `Boolean`
106+
107+
Gets or sets the value, indicating whether to register with the ScriptManager control on the page.
108+
109+
#### Remarks
110+
If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods.
111+
112+
### RenderMode `RenderMode`
113+
114+
Specifies the rendering mode of the control. Setting the mode to Lightweight will yield
115+
HTML 5/CSS 3 html and css.
116+
117+
#### Remarks
118+
Lightweight rendering mode might change the outlook of the component in some older browsers
119+
that don't support CSS3/HTML5.
120+
121+
### ResolvedRenderMode `RenderMode`
122+
123+
Returns resolved RenderMode should the original value was Auto
124+
125+
### Rounded `RadSignatureRounded`
126+
127+
Sets a value controlling the border radius. Can also be set to the following string values: "small"; "medium"; "large" or "none".
128+
129+
### RuntimeSkin `String`
130+
131+
Gets the real skin name for the control user interface. If Skin is not set, returns
132+
"Default", otherwise returns Skin.
133+
134+
### Size `RadSignatureSize`
135+
136+
Sets a value controlling the padding of the RadSignature DIV wrapper element. Can also be set to the following string values: "small"; "medium"; "large" or "none".
137+
138+
### Skin `String`
139+
140+
Gets or sets the skin name for the control user interface.
141+
142+
#### Remarks
143+
If this property is not set, the control will render using the skin named "Default".
144+
If EnableEmbeddedSkins is set to false, the control will not render skin.
145+
146+
### Smooth `Boolean`
147+
148+
A value indicating whether to smoothen out the signature lines.
149+
150+
### StrokeWidth `Double`
151+
152+
Defines how wide will the stroke be.
153+
154+
### Value `String`
155+
156+
A string value representing a Base64-encoded PNG image
157+
158+
## Methods
159+
160+
### ApplyConditionalRendering
161+
162+
Use this from RenderContents of the inheritor
163+
164+
#### Returns
165+
166+
`System.Void`
167+
168+
### ControlPreRender
169+
170+
Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason
171+
172+
#### Returns
173+
174+
`System.Void`
175+
176+
### GetEmbeddedSkinNames
177+
178+
Returns the names of all embedded skins. Used by Telerik.Web.Examples.
179+
180+
#### Returns
181+
182+
`System.Collections.Generic.List`1`
183+
184+
### LoadClientState
185+
186+
Loads the client state data
187+
188+
#### Parameters
189+
190+
#### clientState `System.Collections.Generic.Dictionary{System.String,System.Object}`
191+
192+
#### Returns
193+
194+
`System.Void`
195+
196+
### LoadPostData
197+
198+
Executed when post data is loaded from the request
199+
200+
#### Parameters
201+
202+
#### postDataKey `System.String`
203+
204+
#### postCollection `System.Collections.Specialized.NameValueCollection`
205+
206+
#### Returns
207+
208+
`System.Boolean`
209+
210+
### RaisePostDataChangedEvent
211+
212+
Executed when post data changes should invoke a changed event
213+
214+
#### Returns
215+
216+
`System.Void`
217+
218+
### RegisterCssReferences
219+
220+
Registers the CSS references
221+
222+
#### Returns
223+
224+
`System.Void`
225+
226+
### RegisterScriptControl
227+
228+
Registers the control with the ScriptManager
229+
230+
#### Returns
231+
232+
`System.Void`
233+
234+
### SaveClientState
235+
236+
Saves the client state data
237+
238+
#### Returns
239+
240+
`System.String`
241+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Telerik.Web.UI.RadSignatureConverter
3+
page_title: Telerik.Web.UI.RadSignatureConverter
4+
description: Telerik.Web.UI.RadSignatureConverter
5+
---
6+
7+
# Telerik.Web.UI.RadSignatureConverter
8+
9+
Serialization JS converter class for RadSignature
10+
11+
## Inheritance Hierarchy
12+
13+
* System.Object
14+
* System.Web.Script.Serialization.JavaScriptConverter
15+
* Telerik.Web.UI.ExplicitJavaScriptConverter
16+
* Telerik.Web.UI.RadSignatureConverter
17+
18+
## Methods
19+
20+
### AddScript
21+
22+
Serialize the value as a script, not a string. Should be used alongside with
23+
24+
#### Parameters
25+
26+
#### state `System.Collections.Generic.IDictionary{System.String,System.Object}`
27+
28+
The state collection for the values
29+
30+
#### key `System.String`
31+
32+
The key in the JSON object
33+
34+
#### value `System.Object`
35+
36+
The value in the JSON obejct
37+
38+
#### Returns
39+
40+
`System.Void`
41+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Telerik.Web.UI.SignatureClientEvents
3+
page_title: Telerik.Web.UI.SignatureClientEvents
4+
description: Telerik.Web.UI.SignatureClientEvents
5+
---
6+
7+
# Telerik.Web.UI.SignatureClientEvents
8+
9+
Defines the client events handlers.
10+
11+
## Inheritance Hierarchy
12+
13+
* System.Object
14+
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager
15+
* Telerik.Web.UI.SignatureClientEvents : IDefaultCheck
16+
17+
## Properties
18+
19+
### OnChange `String`
20+
21+
Fired when the value of the RadSignature is changed by the user.
22+
23+
### OnClose `String`
24+
25+
Fires when the value popup of the component gets closed.
26+
27+
### OnInitialize `String`
28+
29+
Fired when the Signature control is initialized.
30+
31+
### OnLoad `String`
32+
33+
Fired when the Signature control is loaded on the page.
34+
35+
### OnOpen `String`
36+
37+
Fires when the value popup of the component gets opened.
38+

0 commit comments

Comments
 (0)