FineUIPro

https://fineui.com/pro/api/
Admin
FineUIPro is an ASP.NET low-code rapid development framework that provides a comprehensive set of UI...
Tokens:420,761
Snippets:1,811
Trust Score:7.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET FineUIPro.GlobalConfig.ProductVersion

Source: https://fineui.com/pro/api/a00878.html

Retrieves the current version string of the FineUIPro library.

```APIDOC
## GET FineUIPro.GlobalConfig.ProductVersion

### Description
Retrieves the current version string of the FineUIPro library.

### Method
GET

### Response
#### Success Response (200)
- **ProductVersion** (string) - The current version of the FineUIPro library.
```

--------------------------------

### Get ShowInTop Reference

Source: https://fineui.com/pro/api/a01250.html

Generates client-side script to display a message dialog in the top-most window.

```APIDOC
## GET /api/message/getShowInTopReference

### Description
Retrieves the client-side JavaScript code to display a message dialog in the top-most window.

### Method
GET

### Endpoint
/api/message/getShowInTopReference

### Parameters
#### Query Parameters
- **message** (string) - Required - The message to display in the dialog.
- **title** (string) - Optional - The title of the dialog window.
- **icon** (MessageBoxIcon) - Optional - The icon to display in the dialog.
- **okScript** (string) - Optional - JavaScript code to execute when the OK button is clicked.

### Response
#### Success Response (200)
- **script** (string) - The client-side JavaScript code for displaying the dialog in the top-most window.

#### Response Example
```json
{
  "script": "FineUI.MessageBox.showInTop({ message: 'System alert!', title: 'Alert' });"
}
```
```

--------------------------------

### Get Show Reference

Source: https://fineui.com/pro/api/a01250.html

Generates client-side script to display a message dialog.

```APIDOC
## GET /api/message/getShowReference

### Description
Retrieves the client-side JavaScript code to display a message dialog.

### Method
GET

### Endpoint
/api/message/getShowReference

### Parameters
#### Query Parameters
- **message** (string) - Required - The message to display in the dialog.
- **title** (string) - Optional - The title of the dialog window.
- **icon** (MessageBoxIcon) - Optional - The icon to display in the dialog.
- **okScript** (string) - Optional - JavaScript code to execute when the OK button is clicked.
- **target** (Target) - Optional - The target frame or window for the dialog.
- **iconUrl** (string) - Optional - A custom URL for the dialog icon.

### Response
#### Success Response (200)
- **script** (string) - The client-side JavaScript code for displaying the dialog.

#### Response Example
```json
{
  "script": "FineUI.MessageBox.show({ message: 'Operation completed.', title: 'Success' });"
}
```
```

--------------------------------

### ClientID Property

Source: https://fineui.com/pro/api/a00838.html

Gets the client-side ID of the control, used in JavaScript. Example: RegionPanel1_Button1.

```csharp
override string ClientID` [get]
```

--------------------------------

### Register startup script with formatting

Source: https://fineui.com/pro/api/a01262.html

Allows registering a script with dynamic content using format strings and parameters, similar to string.Format.

```csharp
FineUIPro.PageContext.RegisterStartupScript("var msg = '{0}'; alert(msg);", "Hello World");
```

--------------------------------

### WrapperID Property

Source: https://fineui.com/pro/api/a00838.html

Gets the client-side ID of the control's wrapper element. Example: Button1_wrapper.

```csharp
string WrapperID` [get]
```

--------------------------------

### Register post-startup script with a key

Source: https://fineui.com/pro/api/a01262.html

Allows registering a post-startup script using a unique key for better management of multiple scripts.

```csharp
FineUIPro.PageContext.RegisterPostStartupScript("myPostScriptKey", "console.log('Post-script with key');");
```

--------------------------------

### GetPostBackEventReference Method (with argument)

Source: https://fineui.com/pro/api/a00790.html

Gets the client-side script for triggering a post-back event with a specified argument. Example: __doPostBack('btnChangeEnable','');

```csharp
string GetPostBackEventReference (string eventArgument)
```

--------------------------------

### Register startup script with key and script tag option

Source: https://fineui.com/pro/api/a01262.html

Allows registering a startup script with a key and controlling whether `<script>` tags are automatically added.

```csharp
FineUIPro.PageContext.RegisterStartupScript("myStartupScriptKeyWithTag", "alert('Startup script with key and tag');", true);
```

--------------------------------

### GetPostBackEventReference Method (no arguments)

Source: https://fineui.com/pro/api/a00790.html

Gets the client-side script for triggering a post-back event without any specific argument. Example: __doPostBack('btnChangeEnable','');

```csharp
string GetPostBackEventReference ()
```

--------------------------------

### Register pre-startup script with a key

Source: https://fineui.com/pro/api/a01262.html

Allows registering a pre-startup script using a unique key, which can be useful for managing multiple scripts.

```csharp
FineUIPro.PageContext.RegisterPreStartupScript("myPreScriptKey", "console.log('Pre-script with key');");
```

--------------------------------

### Register pre-startup script with key and script tag option

Source: https://fineui.com/pro/api/a01262.html

Combines key-based registration with the option to control script tag inclusion for pre-startup scripts.

```csharp
FineUIPro.PageContext.RegisterPreStartupScript("myPreScriptKeyWithTag", "console.log('Pre-script with key and tag');", true);
```

--------------------------------

### Control Specific API Example

Source: https://fineui.com/pro/api/dir_a534f0870b9e43efbd6d40957caea9e5.html

Example endpoint for a specific control, like DatePicker.

```APIDOC
## GET /api/controls/DatePicker

### Description
Retrieves details and configuration options for the DatePicker control.

### Method
GET

### Endpoint
/api/controls/DatePicker

### Response
#### Success Response (200)
- **controlName** (string) - The name of the control.
- **description** (string) - A description of the control.
- **properties** (object) - Available properties for the DatePicker.

#### Response Example
```json
{
  "controlName": "DatePicker",
  "description": "A control for selecting dates.",
  "properties": {
    "Value": {
      "type": "DateTime",
      "description": "The selected date."
    },
    "Format": {
      "type": "string",
      "description": "The date format string."
    }
  }
}
```
```

--------------------------------

### Register post-startup script with key and script tag option

Source: https://fineui.com/pro/api/a01262.html

Combines key-based registration with script tag control for post-startup scripts.

```csharp
FineUIPro.PageContext.RegisterPostStartupScript("myPostScriptKeyWithTag", "console.log('Post-script with key and tag');", true);
```

--------------------------------

### Get Focus Script Reference

Source: https://fineui.com/pro/api/a00814.html

Gets the client-side script for setting focus to the control.

```csharp
string GetFocusReference ()
```

--------------------------------

### Get Focus Script Reference with Selection

Source: https://fineui.com/pro/api/a00814.html

Gets the client-side script for setting focus and selecting text in the control.

```csharp
string GetFocusReference (bool selectText)
```

--------------------------------

### Register startup script with key

Source: https://fineui.com/pro/api/a01262.html

Registers a startup script using a unique key, useful for managing and preventing duplicate script registrations.

```csharp
FineUIPro.PageContext.RegisterStartupScript("myStartupScriptKey", "alert('Startup script with key');");
```

--------------------------------

### Get PostBack Event Reference

Source: https://fineui.com/pro/api/a00810.html

Gets the client-side script for posting back to the page, e.g., __doPostBack('btnChangeEnable','');

```csharp
string GetPostBackEventReference ();
```

--------------------------------

### FineUIPro.Prompt.ShowInTop

Source: https://fineui.com/pro/api/a01266.html

Displays a dialog box in the top-level window.

```APIDOC
## FineUIPro.Prompt.ShowInTop

### Description
Displays a dialog box in the top-level window. Supports various overloads for message, title, icon, and button scripts.

### Parameters
- **message** (string) - Required - Message body
- **title** (string) - Optional - Dialog title
- **icon** (MessageBoxIcon) - Optional - Icon type
- **okScript** (string) - Optional - Client-side script for OK button
- **cancelScript** (string) - Optional - Client-side script for Cancel button
```

--------------------------------

### Class Members starting with 'N'

Source: https://fineui.com/pro/api/functions_n.html

Lists class members, their types, and associated classes for members starting with the letter 'N'.

```APIDOC
## Class Members starting with 'N'

### Description
This section details various class members, including properties, methods, and events, that begin with the letter 'N'. It specifies the member's name, its type, and the classes it belongs to.

### Members
- **NavigateUrl** (Property) - Belongs to: FineUIPro.DataListItem, FineUIPro.HyperLink, FineUIPro.HyperLinkField, FineUIPro.MenuHyperLink, FineUIPro.TreeNode
- **NewLineToBR()** (Method) - Belongs to: FineUIPro.StringUtil
- **NewPageIndex** (Property) - Belongs to: FineUIPro.GridPageEventArgs
- **NextClickControl** (Property) - Belongs to: FineUIPro.TextArea, FineUIPro.TextField
- **NextFocusControl** (Property) - Belongs to: FineUIPro.TextArea, FineUIPro.TextField
- **Node** (Property) - Belongs to: FineUIPro.TreeCheckEventArgs, FineUIPro.TreeCommandEventArgs, FineUIPro.TreeNodeEventArgs
- **NodeCheck** (Event) - Belongs to: FineUIPro.Tree
- **NoDecimal** (Property) - Belongs to: FineUIPro.NumberBox
- **NodeCollapse** (Event) - Belongs to: FineUIPro.Tree
- **NodeCommand** (Event) - Belongs to: FineUIPro.Tree
- **NodeDataBound** (Event) - Belongs to: FineUIPro.Tree
- **NodeExpand** (Event) - Belongs to: FineUIPro.Tree
- **NodeID** (Property) - Belongs to: FineUIPro.TreeCheckEventArgs, FineUIPro.TreeCommandEventArgs, FineUIPro.TreeNode, FineUIPro.TreeNodeEventArgs
- **NodeLazyLoad** (Event) - Belongs to: FineUIPro.Tree
- **Nodes** (Property) - Belongs to: FineUIPro.Tree, FineUIPro.TreeNode
- **NoNegative** (Property) - Belongs to: FineUIPro.NumberBox
- **NullDisplayText** (Property) - Belongs to: FineUIPro.BoundField, FineUIPro.RenderField
- **NumberBox()** (Constructor) - Belongs to: FineUIPro.NumberBox
- **NumberPrefix** (Property) - Belongs to: FineUIPro.NumberBox
- **NumberSuffix** (Property) - Belongs to: FineUIPro.NumberBox
- **NumberToString()** (Method) - Belongs to: FineUIPro.JsHelper
```

--------------------------------

### FineUIPro.Prompt.Show

Source: https://fineui.com/pro/api/a01266.html

Displays a dialog box with various configuration options for messages, titles, icons, and callback scripts.

```APIDOC
## FineUIPro.Prompt.Show

### Description
Displays a dialog box. Multiple overloads are available to specify message, title, icons, and client-side scripts for OK and Cancel actions.

### Parameters
- **message** (string) - Required - Dialog message
- **title** (string) - Optional - Dialog title
- **messageBoxIcon** (MessageBoxIcon) - Optional - Icon type
- **okScript** (string) - Optional - Client-side script for OK button
- **cancelScript** (string) - Optional - Client-side script for Cancel button
- **target** (Target) - Optional - Target page for the dialog
- **icon** (Icon) - Optional - Custom dialog icon
- **iconUrl** (string) - Optional - Custom icon URL
```

--------------------------------

### FineUIPro Component Constructors

Source: https://fineui.com/pro/api/functions_func_b.html

Documentation for the initialization of core FineUIPro UI components.

```APIDOC
## FineUIPro Component Constructors

### Description
Initializes various UI components within the FineUIPro framework.

### Components
- **BaseCollection()** - Initializes a new instance of FineUIPro.BaseCollection<T>
- **BoxComponent()** - Initializes a new instance of FineUIPro.BoxComponent
- **Button()** - Initializes a new instance of FineUIPro.Button
- **ButtonCollection()** - Initializes a new instance of FineUIPro.ButtonCollection
```

--------------------------------

### Get Focus Script Reference with Selection and Delay

Source: https://fineui.com/pro/api/a00814.html

Gets the client-side script for setting focus, selecting text, and applying a delay to the control.

```csharp
string GetFocusReference (bool selectText, int delayMilliseconds)
```

--------------------------------

### Get PostBack Event Reference with Argument

Source: https://fineui.com/pro/api/a00810.html

Gets the client-side script for posting back to the page with a specified event argument, e.g., __doPostBack('btnChangeEnable','true');

```csharp
string GetPostBackEventReference (string eventArgument);
```

--------------------------------

### Register Startup Script

Source: https://fineui.com/pro/api/a01262.html

Methods to register client-side scripts for page initialization and AJAX callbacks.

```APIDOC
## RegisterStartupScript(string formatString, params object[] formatValues)

### Description
Registers a client-side script using a format string and parameters, suitable for page initialization and AJAX callbacks.

### Method
void

### Endpoint
FineUIPro.PageContext.RegisterStartupScript(string formatString, params object[] formatValues)

### Parameters
#### Path Parameters
- **formatString** (string) - Required - The format string for the script.
- **formatValues** (params object[]) - Required - The parameters for the format string.

## RegisterStartupScript(string key, string scriptContent)

### Description
Registers a client-side script with a key, to be executed after automatically generated scripts.

### Method
void

### Endpoint
FineUIPro.PageContext.RegisterStartupScript(string key, string scriptContent)

### Parameters
#### Path Parameters
- **key** (string) - Required - The key for the script.
- **scriptContent** (string) - Required - The content of the client-side script.

## RegisterStartupScript(string key, string scriptContent, bool addScriptTag)

### Description
Registers a client-side script with a key and an option to add script tags, to be executed after automatically generated scripts.

### Method
void

### Endpoint
FineUIPro.PageContext.RegisterStartupScript(string key, string scriptContent, bool addScriptTag)

### Parameters
#### Path Parameters
- **key** (string) - Required - The key for the script.
- **scriptContent** (string) - Required - The content of the client-side script.
- **addScriptTag** (bool) - Required - Whether to add script tags.

## RegisterStartupScript(string scriptContent)

### Description
Registers a client-side script suitable for page initialization and AJAX callbacks.

### Method
void

### Endpoint
FineUIPro.PageContext.RegisterStartupScript(string scriptContent)

### Parameters
#### Path Parameters
- **scriptContent** (string) - Required - The content of the client-side script.
```

--------------------------------

### Get PostBack Event Reference with Argument and Ajax Enable

Source: https://fineui.com/pro/api/a00810.html

Gets the client-side script for posting back to the page with a specified event argument and Ajax enabled, e.g., __doPostBack('btnChangeEnable','true');

```csharp
string GetPostBackEventReference (string eventArgument, bool enableAjax);
```

--------------------------------

### Get PostBack Event Reference with Argument, Ajax Enable, and Persist Original

Source: https://fineui.com/pro/api/a00810.html

Gets the client-side script for posting back to the page with a specified event argument, Ajax enabled, and persistence of the original state, e.g., __doPostBack('btnChangeEnable','true');

```csharp
string GetPostBackEventReference (string eventArgument, bool enableAjax, bool persistOriginal);
```

--------------------------------

### Register post-startup script with script tag option

Source: https://fineui.com/pro/api/a01262.html

Provides an option to include or exclude `<script>` tags when registering the post-startup script.

```csharp
FineUIPro.PageContext.RegisterPostStartupScript("console.log('Post-script without tags');", false);
```

--------------------------------

### HideMode Property

Source: https://fineui.com/pro/api/a00838.html

Gets or sets the mode for hiding the control.

```csharp
virtual HideMode HideMode` [get, set]
```

--------------------------------

### FineUIPro Menus and Toolbars

Source: https://fineui.com/pro/api/a01567.html

Documentation for menu and toolbar components.

```APIDOC
## FineUIPro Menus and Toolbars

### Description
This section covers components for creating navigation menus and toolbars to enhance user interaction and application navigation.

### Classes
- **Menu**: A context menu or application menu.
- **BaseMenuItem**: Base class for menu items.
- **MenuButton**: A button within a menu.
- **MenuCheckBox**: A checkbox within a menu.
- **MenuHyperLink**: A hyperlink within a menu.
- **MenuItem**: A standard menu item.
- **MenuItemCollection**: Collection of MenuItems.
- **MenuSeparator**: A separator line in a menu.
- **MenuText**: A text item in a menu.
- **Toolbar**: A toolbar component.
- **ToolbarFill**: A flexible space in a toolbar.
- **ToolbarSeparator**: A separator line in a toolbar.
- **ToolbarText**: A text item in a toolbar.
- **ToolbarCollection**: Collection of toolbar items.
- **Tool**: A tooltip component.
- **ToolCollection**: Collection of Tooltip components.
```

--------------------------------

### ID Property

Source: https://fineui.com/pro/api/a00838.html

Gets or sets the unique identifier for the control.

```csharp
override string ID` [get, set]
```

--------------------------------

### FineUIPro.Prompt Methods

Source: https://fineui.com/pro/api/a01266.html

Methods for displaying the prompt dialog and retrieving references for client-side execution.

```APIDOC
## FineUIPro.Prompt Methods

### Description
Methods to trigger the display of the prompt dialog or retrieve the JavaScript reference for client-side interaction.

### Methods
- **Show()** - Displays the prompt dialog.
- **GetShowReference()** - Returns the JavaScript reference to show the dialog.
- **ShowInParent()** - Displays the dialog within the parent context.
- **ShowInTop()** - Displays the dialog in the top-level window context.
- **GetShowInParentReference()** - Returns the JavaScript reference to show the dialog in the parent.
- **GetShowInTopReference()** - Returns the JavaScript reference to show the dialog in the top-level window.
```

--------------------------------

### ProductVersion Property

Source: https://fineui.com/pro/api/a00838.html

Gets the version of the product associated with the control.

```csharp
virtual string ProductVersion` [get]
```

--------------------------------

### FineUIPro Core Methods

Source: https://fineui.com/pro/api/functions_func.html

Documentation for core framework methods including collection management and UI component manipulation.

```APIDOC
## FineUIPro Core Methods

### Description
Provides access to core framework methods for managing UI components and data collections.

### Methods
- **AccordionPane()**: Initializes a new instance of the AccordionPane class.
- **AccordionPaneCollection()**: Initializes a new instance of the AccordionPaneCollection class.
- **Add(item)**: Adds an item to collections such as CheckItemCollection, DataListItemCollection, ListItemCollection, or RadioItemCollection.
- **AddNewRecord()**: Adds a new record to a Grid component.
- **AddProperty(key, value)**: Adds a property to JsArrayBuilder or JsObjectBuilder.
- **AppendData(data)**: Appends data to DataList or Grid components.
```

--------------------------------

### ProductName Property

Source: https://fineui.com/pro/api/a00838.html

Gets the name of the product associated with the control.

```csharp
string ProductName` [get]
```

--------------------------------

### FineUIPro Window and Alert Components

Source: https://fineui.com/pro/api/a01638.html

Documentation for components related to windows, alerts, and user notifications.

```APIDOC
## FineUIPro Window and Alert Components

### Description
Provides components for displaying modal windows, alerts, confirmations, and notifications to the user.

### Classes
- **ActiveWindow**: Represents an active window.
- **Alert**: Displays an alert message.
- **Confirm**: Displays a confirmation dialog.
- **Notify**: Displays a non-modal notification.
- **PageContext**: Provides context for the current page.
- **Prompt**: Displays a prompt dialog for user input.
- **WindowCloseEventArgs**: Arguments for window close events.
- **Window**: Represents a modal window.
- **PageLoading**: Component to indicate page loading status.
```

--------------------------------

### ScriptModule Member Function Explanations

Source: https://fineui.com/pro/api/a01198.html

Provides specific explanations for the member functions Dispose and Init.

```APIDOC
## Member Function Explanations

### Dispose()

- **Signature**: `void FineUIPro.ScriptModule.Dispose()`
- **Description**: Clears resources.

### Init(HttpApplication context)

- **Signature**: `void FineUIPro.ScriptModule.Init(HttpApplication context)`
- **Description**: Initializes the module.
- **Parameter**: `context` (HttpApplication) - The HTTP application context.
```

--------------------------------

### Listeners Property

Source: https://fineui.com/pro/api/a00838.html

Gets the collection of client-side event listeners for the control.

```csharp
virtual ListenerCollection Listeners` [get]
```

--------------------------------

### AjaxLoadingType Property

Source: https://fineui.com/pro/api/a00838.html

Gets or sets the type of the AJAX loading indicator.

```csharp
AjaxLoadingType AjaxLoadingType` [get, set]
```

--------------------------------

### FineUIPro.StyleUtil Methods

Source: https://fineui.com/pro/api/a01239.html

API documentation for static methods within the StyleUtil class.

```APIDOC
## FineUIPro.StyleUtil

### Description
Utility class for generating CSS styles.

### Methods

- **GetBackgroundStyle(string selector, string imageUrl)**: Returns a background style string.
- **GetNoRepeatBackgroundStyle(string selector, string imageUrl)**: Returns a non-repeating background style string.
- **GetSingleStyleFormCSS(string css, string styleName)**: Extracts a single style value from a CSS string.

### Parameters

#### GetBackgroundStyle
- **selector** (string) - Required - The CSS selector.
- **imageUrl** (string) - Required - The URL of the background image.

#### GetNoRepeatBackgroundStyle
- **selector** (string) - Required - The CSS selector.
- **imageUrl** (string) - Required - The URL of the background image.

#### GetSingleStyleFormCSS
- **css** (string) - Required - The full CSS string.
- **styleName** (string) - Required - The name of the style property to extract.
```

--------------------------------

### FineUIPro.Prompt Class Methods

Source: https://fineui.com/pro/api/a01266.html

Methods for generating client-side scripts to display prompt dialogs in parent or top-level windows.

```APIDOC
## GetShowInParentReference

### Description
Generates the client-side script to display a prompt dialog within the parent page.

### Parameters
- **message** (string) - Required - The dialog message body.
- **title** (string) - Optional - The dialog title.
- **icon** (MessageBoxIcon) - Optional - The dialog icon.
- **okScript** (string) - Optional - JavaScript to execute on OK click.
- **cancelScript** (string) - Optional - JavaScript to execute on Cancel click.

### Response
- **string** - The generated client-side script.

## GetShowInTopReference

### Description
Generates the client-side script to display a prompt dialog within the top-level page.

### Parameters
- **message** (string) - Required - The dialog message body.
- **title** (string) - Optional - The dialog title.
- **icon** (MessageBoxIcon) - Optional - The dialog icon.
- **okScript** (string) - Optional - JavaScript to execute on OK click.
- **cancelScript** (string) - Optional - JavaScript to execute on Cancel click.

### Response
- **string** - The generated client-side script.
```

--------------------------------

### EnableAjax Property

Source: https://fineui.com/pro/api/a00838.html

Gets or sets whether AJAX is enabled for the control.

```csharp
virtual bool EnableAjax` [get, set]
```

--------------------------------

### FineUIPro Window and Utility Functions

Source: https://fineui.com/pro/api/functions_func_w.html

Documentation for core FineUIPro window management and JSON serialization helper functions.

```APIDOC
## Window()

### Description
Initializes a new instance of the FineUIPro.Window class.

### Method
Constructor

### Response
- **Returns** (FineUIPro.Window) - A new window instance.

---

## WindowCloseEventArgs()

### Description
Initializes a new instance of the WindowCloseEventArgs class used for handling window close events.

### Method
Constructor

### Response
- **Returns** (FineUIPro.WindowCloseEventArgs) - Event arguments for window closure.

---

## WriteBackValue()

### Description
Writes a value back from the active window to the parent page.

### Method
Static Method

### Endpoint
FineUIPro.ActiveWindow.WriteBackValue()

---

## WriteJson()

### Description
Serializes data to JSON format using the FineUIPro JSONDateTimeConvertor.

### Method
Static Method

### Endpoint
FineUIPro.JSONDateTimeConvertor.WriteJson()
```

--------------------------------

### AttributeDataTag Property

Source: https://fineui.com/pro/api/a00838.html

Gets or sets the HTML 'data-tag' attribute for the control.

```csharp
string AttributeDataTag` [get, set]
```

--------------------------------

### Class Members - U

Source: https://fineui.com/pro/api/functions_u.html

Documentation for class members starting with 'U'.

```APIDOC
## Class Members - U

### Description
This section lists documented class members starting with the letter 'U'.

### UncheckAllNodes()
  * **Type**: FineUIPro.Tree
  * **Description**: Unchecks all nodes in a tree.

### Ungzip()
  * **Type**: FineUIPro.StringUtil
  * **Description**: Decompresses a gzipped string.

### UpdateCellValue()
  * **Type**: FineUIPro.Grid
  * **Description**: Updates the value of a cell in a grid.

### UpdateTemplateFields()
  * **Type**: FineUIPro.Grid
  * **Description**: Updates template fields in a grid.

### UrlEncode
  * **Type**: FineUIPro.HyperLinkField, FineUIPro.WindowField
  * **Description**: Represents a URL encoding property for HyperLinkField and WindowField.
```

--------------------------------

### FineUIPro.IconHelper Methods

Source: https://fineui.com/pro/api/a01007.html

A collection of static methods for handling Icon objects and their corresponding URLs.

```APIDOC
## FineUIPro.IconHelper Methods

### Description
Utility class for managing icons within the FineUIPro framework, including conversion and URL resolution.

### Methods
- **GetIconUrl(Icon icon)**: Returns the URL for a given icon.
- **GetName(Icon type)**: Returns the name of the icon type.
- **GetResolvedIconUrl(Icon icon)**: Returns the resolved URL for an icon.
- **GetResolvedIconUrl(Icon icon, string iconUrl)**: Returns the resolved URL for an icon with a custom icon URL.
- **Icon2String(Icon type)**: Converts an Icon type to its string representation.
- **String2Icon(string text, bool ignoreCase)**: Converts a string to an Icon type, with an option to ignore case.
```

--------------------------------

### Property and Object Utility Functions

Source: https://fineui.com/pro/api/functions_func_g.html

Functions for getting properties and working with objects.

```APIDOC
## Property and Object Utility Functions

### GetProperty()

Retrieves a property from an object.

### GetPropertyValue()

Retrieves the value of a property.
```

--------------------------------

### Register startup script for page initialization

Source: https://fineui.com/pro/api/a01262.html

This method registers a script that will be executed when the page is initialized. It's useful for setting up initial states or behaviors.

```csharp
FineUIPro.PageContext.RegisterStartupScript("alert('Page loaded!');");
```
Tokens:
Raw