Skip to content

Signature documentation #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,9 @@ navigation:
"controls/searchbox":
title: "SearchBox"
position: 1
"controls/signature":
title: "Signature"
position: 1
"controls/sitemap":
title: "Sitemap"
position: 1
Expand Down Expand Up @@ -1990,6 +1993,7 @@ intro_columns:
"DropDownList": "dropdownlist/overview"
"DropDownTree": "dropdowntree/overview"
"Editor": "editor/overview"
"Signature": "signature/overview"
"Image Editor": "imageeditor/overview"
"InputManager": "radinputmanager/overview"
"Label": "label/overview"
Expand Down
4 changes: 4 additions & 0 deletions api/server/Telerik.Web.UI/RadDropDownList.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,10 @@ The CssClass property will now be used instead of the former Skin

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

### DropDownAutoWidth `RadDropDownListDropDownAutoWidth`

Gets or sets whether to enable/disable the RadDropDownList drop down auto width.

### DropDownHeight `Unit`

Gets or sets the height of the dropdown in pixels.
Expand Down
241 changes: 241 additions & 0 deletions api/server/Telerik.Web.UI/RadSignature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,241 @@
---
title: Telerik.Web.UI.RadSignature
page_title: Telerik.Web.UI.RadSignature
description: Telerik.Web.UI.RadSignature
---

# Telerik.Web.UI.RadSignature

## 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.RadSignature

## Properties

### BackColor `Color`

Gets or sets the background color of the signature.

### ClientEvents `SignatureClientEvents`

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()

### Enable `Boolean`

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.

### 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

### FillMode `RadSignatureFillMode`

Sets a value controlling how the color is applied. Can also be set to the following string values: "solid"; "flat"; "outline" or "none".

### ForeColor `Color`

The stroke color of the signature.

### HideLine `Boolean`

A value indicating whether the dotted line should be displayed in the background.

### IsSkinSet `String`

For internal use.

### Label `String`

Specifies the label that will be rendered on the k-signature-canvas element of the component with the aria-label attribute.

### Maximizable `Boolean`

A value indicating whether the component can be maximized

### PopupScale `Double`

Defines a value indicating the scaling size of the popup signature pad

### ReadOnly `Boolean`

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.

### 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

### Rounded `RadSignatureRounded`

Sets a value controlling the border radius. Can also be set to the following string values: "small"; "medium"; "large" or "none".

### RuntimeSkin `String`

Gets the real skin name for the control user interface. If Skin is not set, returns
"Default", otherwise returns Skin.

### Size `RadSignatureSize`

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".

### 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.

### Smooth `Boolean`

A value indicating whether to smoothen out the signature lines.

### StrokeWidth `Double`

Defines how wide will the stroke be.

### Value `String`

A string value representing a Base64-encoded PNG image

## 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`

41 changes: 41 additions & 0 deletions api/server/Telerik.Web.UI/RadSignatureConverter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Telerik.Web.UI.RadSignatureConverter
page_title: Telerik.Web.UI.RadSignatureConverter
description: Telerik.Web.UI.RadSignatureConverter
---

# Telerik.Web.UI.RadSignatureConverter

Serialization JS converter class for RadSignature

## Inheritance Hierarchy

* System.Object
* System.Web.Script.Serialization.JavaScriptConverter
* Telerik.Web.UI.ExplicitJavaScriptConverter
* Telerik.Web.UI.RadSignatureConverter

## 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`

38 changes: 38 additions & 0 deletions api/server/Telerik.Web.UI/SignatureClientEvents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Telerik.Web.UI.SignatureClientEvents
page_title: Telerik.Web.UI.SignatureClientEvents
description: Telerik.Web.UI.SignatureClientEvents
---

# Telerik.Web.UI.SignatureClientEvents

Defines the client events handlers.

## Inheritance Hierarchy

* System.Object
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager
* Telerik.Web.UI.SignatureClientEvents : IDefaultCheck

## Properties

### OnChange `String`

Fired when the value of the RadSignature is changed by the user.

### OnClose `String`

Fires when the value popup of the component gets closed.

### OnInitialize `String`

Fired when the Signature control is initialized.

### OnLoad `String`

Fired when the Signature control is loaded on the page.

### OnOpen `String`

Fires when the value popup of the component gets opened.

Loading