Syncfusion

https://github.com/yakdoli/syncfusion-v11-documents
Admin
Syncfusion v11 Documents is a comprehensive documentation repository for Syncfusion v11 components...
Tokens:419,219
Snippets:1,947
Trust Score:3.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### View Setup and Watermark Attributes

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MVC/MVC_DOCIO.1/SUMMARY.md

API documentation for view setup configurations and watermark settings.

```APIDOC
## View Setup and Watermark Attributes

### Description
This section details API endpoints for configuring document view settings (like zoom level and view type) and managing watermarks (both picture and text-based).

### Method
GET

### Endpoint
/api/documents/view-watermark/{attribute_type}

### Parameters
#### Path Parameters
- **attribute_type** (string) - Required - The type of attribute to query (e.g., ViewSetupZoomPercentAttr, WatermarkTag, WatermarkTextAttr).

### Request Example
```
GET /api/documents/view-watermark/ViewSetupZoomPercentAttr
```

### Response
#### Success Response (200)
- **attribute** (string) - The name of the attribute.
- **details** (string) - Specific information about the attribute's configuration or purpose.

#### Response Example
```json
{
  "attribute": "ViewSetupZoomPercentAttr",
  "details": "Controls the zoom level of the document view in percentage."
}
```
```

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

### Page Setup Attributes

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_DOCIO.1/SUMMARY.md

Documentation for page setup attributes including margins, orientation, and page dimensions.

```APIDOC
## Page Setup Attributes API

### Description
Details on attributes that configure the page setup for documents, including margins (bottom, footer distance, header distance, left, right, top), orientation, and page dimensions (height, width).

### Method
GET

### Endpoint
/yakdoli/syncfusion-v11-documents/pagesetup/{attribute}

#### Path Parameters
- **attribute** (string) - Required - The specific page setup attribute to retrieve (e.g., `PSBottomMarginAttr`, `PSFooterDistanceAttr`, `PSHeaderDistanceAttr`, `PSLeftMarginAttr`, `PSOrientationAttr`, `PSPageHeightAttr`, `PSPageWidthAttr`, `PSRightMarginAttr`, `PSTopMarginAttr`).

### Response
#### Success Response (200)
- **attribute_details** (object) - Information about the requested page setup attribute.
```

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

### MobProgressBar Constructor Examples

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MobileMVC/MOBILE_MVC_CHART.1/SUMMARY.md

Demonstrates the various constructors for the MobProgressBar class, allowing for initialization with different parameters including HtmlHelper and specific properties. Used for creating progress bar UI elements.

```csharp
// Constructor with HtmlHelper
var htmlHelper = Html.CreateHtmlHelper(); // Assuming HtmlHelper is available
var progressBarWithHelper = new MobProgressBar(htmlHelper);

// Constructor with String, Properties, Dictionary, and HtmlHelper
var properties = new MobProgressBarPropertiesModel();
var dictionary = new System.Collections.Generic.Dictionary<string, object>();
var progressBarFull = new MobProgressBar("progressBarId", properties, dictionary, htmlHelper);
```

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

### BookmarkStart Class Members

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DOCIO.1/SUMMARY.md

Members of the BookmarkStart class, including constructors, methods, and properties.

```APIDOC
## BookmarkStart Class

### Description
Represents the start of a bookmark in the document.

### Constructor
- **BookmarkStart()**: Initializes a new instance of the BookmarkStart class.

### Methods

#### CloneImpl Method

### Description
Creates a deep copy of the BookmarkStart object.

### Method
POST

### Endpoint
`/bookmarkStart/cloneImpl`

### Response
#### Success Response (200)
- **clonedBookmarkStart** (BookmarkStart) - The cloned BookmarkStart object.

#### Response Example
```json
{
  "clonedBookmarkStart": {
    "EntityType": "BookmarkStart",
    "Name": "ExampleBookmark"
  }
}
```

#### CreateLayoutInfo Method

### Description
Creates layout information for the BookmarkStart object.

### Method
POST

### Endpoint
`/bookmarkStart/createLayoutInfo`

### Response
#### Success Response (200)
- **layoutInfo** (LayoutInfo) - The layout information.

#### Response Example
```json
{
  "layoutInfo": {
    "bounds": {"x": 0, "y": 0, "width": 0, "height": 0}
  }
}
```

#### ReadXmlAttributes Method

### Description
Reads XML attributes to populate the BookmarkStart object.

### Method
POST

### Endpoint
`/bookmarkStart/readXmlAttributes`

### Parameters

#### Request Body
- **xmlAttributes** (Object) - Required - The XML attributes to read.

### Response
#### Success Response (200)
- **success** (Boolean) - Indicates if the operation was successful.

#### Response Example
```json
{
  "success": true
}
```

#### WriteXmlAttributes Method

### Description
Writes the BookmarkStart object's attributes to XML.

### Method
POST

### Endpoint
`/bookmarkStart/writeXmlAttributes`

### Response
#### Success Response (200)
- **xmlAttributes** (Object) - The XML attributes representing the BookmarkStart object.

#### Response Example
```json
{
  "xmlAttributes": {
    "Name": "ExampleBookmark"
  }
}
```

### Properties

#### EntityType Property
- **type**: String
- **description**: Gets the entity type of the bookmark start.

#### Name Property
- **type**: String
- **description**: Gets or sets the name of the bookmark.
```

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

### GetPropertyContainerName Method

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DIAGRAM.1/SUMMARY.md

Method to get the name of the property container.

```APIDOC
## GetPropertyContainerName Method

### Description
Retrieves the name of the property container.

### Endpoint
/yakdoli/syncfusion-v11-documents/html/ec31c821-6cad-07cd-e061-d34baff46a00.md

### Method
Not specified (likely part of a class or interface)
```

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

### ChartCustomPointCollection IndexOf Method

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_CHART.1/SUMMARY.md

Gets the index of a ChartCustomPoint in the collection.

```APIDOC
## POST /yakdoli/syncfusion-v11-documents/ChartCustomPointCollection/Methods/IndexOf

### Description
Gets the zero-based index of the first occurrence of a ChartCustomPoint in the collection.

### Method
POST

### Endpoint
/yakdoli/syncfusion-v11-documents/ChartCustomPointCollection/Methods/IndexOf

### Parameters
#### Request Body
- **point** (ChartCustomPoint) - Required. The ChartCustomPoint to locate.

### Request Example
```json
{
  "point": {}
}
```

### Response
#### Success Response (200)
- **index** (integer) - The zero-based index of the point, or -1 if not found.
```

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

### SolidColorBrush API

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_PDF.1/SUMMARY.md

Documentation for the SolidColorBrush class, its members, constructor, and properties.

```APIDOC
## SolidColorBrush API

### Description
Provides access to the members, constructor, and properties of the SolidColorBrush class.

### Endpoints
- `html/b5c15868-ba1b-9311-4346-13d063a5e3de.md` - SolidColorBrush Members
- `html/0e312bd3-2cc3-edbc-670e-a93fbc27e549.md` - SolidColorBrush Constructor
- `html/0db00b0f-890e-d620-8b9a-a29a4a78133d.md` - SolidColorBrush Properties
  - `html/8c939d32-a24c-178a-f72c-55f781caf1a6.md` - Color Property
  - `html/31abca31-7f60-974c-40c0-57029f3bbae5.md` - Key Property
  - `html/29450d28-2dc9-ec25-0c1e-9530745284d2.md` - Opacity Property
```

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

### HTMLUIWindowsAssembly Class

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_HTML UI.1/SUMMARY.md

Documentation for the HTMLUIWindowsAssembly class, focusing on its constructors, fields, and methods related to Windows-specific assembly information.

```APIDOC
## HTMLUIWindowsAssembly Class

### Description
Represents assembly information specific to Windows environments for HTMLUI components.

### Members
- **Constructor**: Initializes a new instance of the `HTMLUIWindowsAssembly` class.
- **Fields**: Contains properties like `Assembly`, `Name`, and `RootNamespace`.
- **Methods**: Includes methods such as `AssemblyResolver`.

### Fields
- **Assembly** (Field) - Description of the assembly.
- **Name** (Field) - The name of the assembly.
- **RootNamespace** (Field) - The root namespace of the assembly.

### Methods
- **AssemblyResolver** (Method) - Resolves the assembly in a Windows context.
```

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

### Item Property (WParagraphCollection)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DOCIO.1/SUMMARY.md

Gets the paragraph at the specified index in the WParagraphCollection.

```APIDOC
## Item Property (WParagraphCollection)

### Description
Gets the paragraph at the specified index from the `WParagraphCollection`.

### Endpoint
N/A (This is a property of `WParagraphCollection`, not an endpoint)

### Method
N/A

### Parameters
#### Path Parameters
- **index** (Integer) - Required - The zero-based index of the paragraph to retrieve.

### Request Example
```json
{
  "index": 0
}
```

### Response
#### Success Response (200)
*   **Item** (WParagraph) - The paragraph at the specified index.

#### Response Example
```json
{
  "Item": {
    "Text": "Sample Paragraph Text"
  }
}
```
```

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

### STREAM_SEEK Enumeration

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MVC/MVC_DOCIO.1/SUMMARY.md

Defines the origin from which to start seeking within a stream.

```APIDOC
## STREAM_SEEK Enumeration

### Description
Defines the origin from which to start seeking within a stream.

### Members
- **SeekBegin**: Marks the beginning of the stream.
- **SeekCurrent**: Marks the current position in the stream.
- **SeekEnd**: Marks the end of the stream.
```

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

### ConnectOptionDialog Class Members

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP CLIENT.1/SUMMARY.md

Documentation for the ConnectOptionDialog class, including its constructors, methods, and properties.

```APIDOC
## ConnectOptionDialog Class

### Description
Represents a dialog for specifying connection options.

### Members

#### Constructor
* **ConnectOptionDialog()**: Initializes a new instance of the `ConnectOptionDialog` class.
* **ConnectOptionDialog(OlapClientToolBar olapClientToolBar)**: Initializes a new instance of the `ConnectOptionDialog` class with a specified OlapClientToolBar.

#### Methods
* **CreateChildControls()**: Creates the child controls for the dialog.
* **OnLoad()**: Handles the load event for the dialog.

#### Properties
* **ConnectionString**: Gets or sets the connection string for the dialog.
```

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

### IPropertyContainer Interface Methods

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_DIAGRAM.1/SUMMARY.md

Documentation for the methods available within the IPropertyContainer interface.

```APIDOC
## GET /api/interfaces/IPropertyContainer/methods

### Description
Retrieves a list of methods available in the IPropertyContainer interface.

### Method
GET

### Endpoint
/api/interfaces/IPropertyContainer/methods

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **methods** (array) - A list of method names.

#### Response Example
{
  "methods": [
    "GetPropertyContainerByName"
  ]
}
```

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

### GET /api/olap/reports

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Retrieves a list of all available OLAP reports in the system.

```APIDOC
## GET /api/olap/reports

### Description
Fetches a list of all OLAP reports stored in the system.

### Method
GET

### Endpoint
/api/olap/reports

### Response
#### Success Response (200)
- **reports** (array) - List of available reports.

#### Response Example
{
  "reports": [
    {
      "id": 1,
      "name": "Sales Report"
    },
    {
      "id": 2,
      "name": "Inventory Report"
    }
  ]
}
```

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

### HTMLUIBaseAssembly Class

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_HTML UI.1/SUMMARY.md

Documentation for the HTMLUIBaseAssembly class, detailing its constructors, fields, and methods related to assembly information.

```APIDOC
## HTMLUIBaseAssembly Class

### Description
Represents the base assembly information for HTMLUI components.

### Members
- **Constructor**: Initializes a new instance of the `HTMLUIBaseAssembly` class.
- **Fields**: Contains properties like `Assembly`, `Name`, and `RootNamespace`.
- **Methods**: Includes methods such as `AssemblyResolver`.

### Fields
- **Assembly** (Field) - Description of the assembly.
- **Name** (Field) - The name of the assembly.
- **RootNamespace** (Field) - The root namespace of the assembly.

### Methods
- **AssemblyResolver** (Method) - Resolves the assembly.
```

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

### IndexRange Structure

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_CHART.1/SUMMARY.md

Represents a range of indices, defined by a start and end value.

```APIDOC
## IndexRange Structure

### Description
Structure used to define a range of indices, typically for data selection or iteration.

### Properties
- **From** (Int32) - Gets or sets the starting index of the range.
- **To** (Int32) - Gets or sets the ending index of the range.
```

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

### RenderingHelper Methods

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DIAGRAM.1/SUMMARY.md

Details the methods available for the RenderingHelper class, including cursor creation and bounding rectangle calculations.

```APIDOC
## RenderingHelper Methods

### Description
Methods for rendering-related tasks.

### Method
Various (Methods)

### Endpoint
N/A (Class Methods)

### Parameters
None (Specific parameters depend on the method overload)

### Request Example
N/A

### Response
N/A
```

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

### Report History Options Methods

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MVC/MVC_REPORTVIEWER.1/SUMMARY.md

Provides methods to get report history options.

```APIDOC
## GetReportHistoryOptions Method

### Description
Retrieves the report history options.

### Method
GET (assumed)

### Endpoint
`/api/documents/reporthistoryoptions` (example endpoint)

### Parameters
None

### Response
#### Success Response (200)
- **options** (Object) - The report history options.

#### Response Example
```json
{
  "options": {
    "includeData": true
  }
}
```
```

```APIDOC
## GetReportHistoryOptionsAsync Method

### Description
Retrieves the report history options asynchronously.

### Method
GET (assumed)

### Endpoint
`/api/documents/reporthistoryoptions/async` (example endpoint)

### Parameters
None

### Response
#### Success Response (200)
- **options** (Object) - The report history options.

#### Response Example
```json
{
  "options": {
    "includeData": true
  }
}
```
```

```APIDOC
## GetReportHistoryOptionsAsync Method (String)

### Description
Retrieves the report history options asynchronously for a specific report.

### Method
GET (assumed)

### Endpoint
`/api/documents/reporthistoryoptions/async/{reportId}` (example endpoint)

### Parameters
#### Path Parameters
- **reportId** (String) - Required - The identifier of the report.

### Response
#### Success Response (200)
- **options** (Object) - The report history options.

#### Response Example
```json
{
  "options": {
    "includeData": true
  }
}
```
```

```APIDOC
## GetReportHistoryOptionsAsync Method (String, Object)

### Description
Retrieves the report history options asynchronously for a specific report with additional options.

### Method
GET (assumed)

### Endpoint
`/api/documents/reporthistoryoptions/async/{reportId}` (example endpoint)

### Parameters
#### Path Parameters
- **reportId** (String) - Required - The identifier of the report.

#### Request Body
- **options** (Object) - Optional - Additional options for the request.

### Response
#### Success Response (200)
- **options** (Object) - The report history options.

#### Response Example
```json
{
  "options": {
    "includeData": true
  }
}
```
```

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

### Report History Limit Methods

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MVC/MVC_REPORTVIEWER.1/SUMMARY.md

Provides methods to get the report history limit.

```APIDOC
## GetReportHistoryLimit Method

### Description
Retrieves the report history limit.

### Method
GET (assumed)

### Endpoint
`/api/documents/reporthistorylimit` (example endpoint)

### Parameters
None

### Response
#### Success Response (200)
- **limit** (Integer) - The report history limit.

#### Response Example
```json
{
  "limit": 10
}
```
```

```APIDOC
## GetReportHistoryLimitAsync Method

### Description
Retrieves the report history limit asynchronously.

### Method
GET (assumed)

### Endpoint
`/api/documents/reporthistorylimit/async` (example endpoint)

### Parameters
None

### Response
#### Success Response (200)
- **limit** (Integer) - The report history limit.

#### Response Example
```json
{
  "limit": 10
}
```
```

```APIDOC
## GetReportHistoryLimitAsync Method (String)

### Description
Retrieves the report history limit asynchronously for a specific report.

### Method
GET (assumed)

### Endpoint
`/api/documents/reporthistorylimit/async/{reportId}` (example endpoint)

### Parameters
#### Path Parameters
- **reportId** (String) - Required - The identifier of the report.

### Response
#### Success Response (200)
- **limit** (Integer) - The report history limit.

#### Response Example
```json
{
  "limit": 10
}
```
```

```APIDOC
## GetReportHistoryLimitAsync Method (String, Object)

### Description
Retrieves the report history limit asynchronously for a specific report with additional options.

### Method
GET (assumed)

### Endpoint
`/api/documents/reporthistorylimit/async/{reportId}` (example endpoint)

### Parameters
#### Path Parameters
- **reportId** (String) - Required - The identifier of the report.

#### Request Body
- **options** (Object) - Optional - Additional options for the request.

### Response
#### Success Response (200)
- **limit** (Integer) - The report history limit.

#### Response Example
```json
{
  "limit": 10
}
```
```

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

### ViewStripEventArgs

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_SCHEDULE.1/SUMMARY.md

Documentation for the ViewStripEventArgs constructor and its properties.

```APIDOC
## ViewStripEventArgs

### Description
Provides information about view strip events.

### Constructor
* ViewStripEventArgs()

### Properties
#### Path Parameters
- **Cancel** (bool) - Optional - Gets or sets a value that indicates whether the event should be canceled.
- **Handled** (bool) - Optional - Gets or sets a value that indicates whether the event has been handled.

### Request Example
```json
{
  "Cancel": true,
  "Handled": false
}
```

### Response
#### Success Response (200)
- **ViewStripEventArgs** (object) - An object containing event details.

#### Response Example
```json
{
  "Cancel": true,
  "Handled": false
}
```
```

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

### Resources API

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_PDF.1/SUMMARY.md

Documentation for the Resources class, its members, constructor, and properties.

```APIDOC
## Resources API

### Description
Provides access to the members, constructor, and properties of the Resources class.

### Endpoints
- `html/17a8fd87-87b7-c250-5045-ff8d4f8bd736.md` - Resources Members
- `html/126d2497-e8d1-7c6f-c7e3-92f6dd5bc61b.md` - Resources Constructor
- `html/2243290e-82a8-365e-4974-55ea46701fb5.md` - Resources Properties
  - `html/7a47d3ff-fb03-0d03-7393-dd08c9818f1a.md` - ResourceDictionary Property
```

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

### CLIPDATA Structure

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DOCIO.1/SUMMARY.md

Documentation for the CLIPDATA structure in the Syncfusion.DocIO.Utilities namespace. No code examples or definitions are provided.

```csharp
// No code example available for CLIPDATA Structure.
```

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

### ServerInfoHeaderValue Property

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MVC/MVC_REPORTVIEWER.1/SUMMARY.md

Gets or sets the server information header value. This property contains metadata about the reporting server.

```APIDOC
## PROPERTY ServerInfoHeaderValue

### Description
Contains metadata about the reporting server, such as version and capabilities.

### Type
String

### Example
"ServerVersion: 11.0.0; Capabilities: ReportManagement, SubscriptionManagement"
```

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

### Syncfusion DocIO API Overview

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_DOCIO.1/SUMMARY.md

This section provides an overview of the Syncfusion DocIO API, detailing its namespaces and key components.

```APIDOC
## Syncfusion DocIO API Documentation

This API provides functionalities for working with documents using the Syncfusion DocIO library.

### Namespaces

*   **Syncfusion.DocIO.ReaderWriter.DataStreamParser.Escher**
    *   Contains enumerations related to Escher objects.
*   **Syncfusion.DocIO.Utilities**
    *   Provides utility classes for document operations, including encoding.
*   **Syncfusion.DocToPDFConverter**
    *   Enables conversion of documents to PDF format.
```

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

### GET /api/olap/getreport

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Retrieves a specific OLAP report by its identifier. Useful for loading previously saved reports.

```APIDOC
## GET /api/olap/getreport

### Description
Retrieves a saved OLAP report using its unique identifier.

### Method
GET

### Endpoint
/api/olap/getreport

### Parameters
#### Query Parameters
- **reportId** (integer) - Required - The unique identifier of the report to retrieve.

### Response
#### Success Response (200)
- **report** (object) - The retrieved OLAP report object.

#### Response Example
{
  "report": {
    "id": 101,
    "name": "Q3 Sales Report",
    "data": "{...}"
  }
}
```

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

### SizeFConverter Class Documentation

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_DIAGRAM.1/SUMMARY.md

Documentation for the SizeFConverter class, including its members, constructor, and methods.

```APIDOC
## SizeFConverter Class

### Description
Converts between SizeF and other data types.

### Members
- [SizeFConverter Members](html/68df8882-66d7-9205-c3ca-905d872d8519.md)

### Constructor
- [SizeFConverter Constructor](html/6ac571b6-efcc-aa1c-adda-532f415482cb.md)

### Methods
- [SizeFConverter Methods](html/30fa12e0-4fbe-2b86-ba7e-99e176a071a0.md)
  - [CanConvertFrom Method](html/43bafd69-07dc-24ad-89cd-58ebc0188a28.md)
  - [ConvertFrom Method](html/7d1addff-4d6c-e00c-ea8b-311783be476c.md)
  - [ConvertTo Method](html/aea478b2-26bd-a9b4-bee2-ef244a62dc4b.md)
  - [GetProperties Method](html/8351f3a2-7234-a06d-1ca0-19b62a3597af.md)
  - [GetPropertiesSupported Method](html/df8138b5-5a65-d7df-cc66-bb1a39309762.md)
```

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

### ICollection.CopyTo Method

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_GROUPING.1/SUMMARY.md

Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

```APIDOC
## ICollection.CopyTo Method

### Description
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.

### Method
POST

### Endpoint
/yakdoli/syncfusion-v11-documents/collection/copyto

### Parameters
#### Request Body
- **array** (array) - Required - The one-dimensional Array that is the destination of the elements copied from the collection. The Count must be greater than or equal to zero.
- **arrayIndex** (integer) - Required - Zero-based index in the array to which the first element of the collection is copied.

### Response
#### Success Response (200)
- **message** (string) - Indicates successful copy operation.

#### Response Example
```json
{
  "message": "Collection copied successfully."
}
```
```

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

### ToolbarWindowsBuilder Methods

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MobileMVC/MOBILE_MVC_GRID.1/SUMMARY.md

Methods available for the ToolbarWindowsBuilder class.

```APIDOC
## ToolbarWindowsBuilder Methods

### Description
Provides methods for configuring and building toolbar elements within a Windows environment.

### Method
GET

### Endpoint
/yakdoli/syncfusion-v11-documents/html/58d1c98f-6dc0-4f23-c5f0-44a2cb6b2a7f.md

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Documentation detailing the methods of ToolbarWindowsBuilder.

#### Response Example
None
```

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

### GetString Method

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DOCIO.1/SUMMARY.md

Details the GetString method of the DocIOEncoding class in Syncfusion.DocIO.Utilities. No code implementation or usage example is provided.

```csharp
// No code example available for GetString Method.
```

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

### MetafileHeader

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DOCIO.1/SUMMARY.md

Documentation for the MetafileHeader class, including its members, constructor, and properties.

```APIDOC
## MetafileHeader

### Description
Provides details about the MetafileHeader, including its members, constructor, and properties.

### Members
[MetafileHeader Members](html/ae7b9a90-e631-c73b-a30c-a46b617a6bd7.md)

### Constructor
[MetafileHeader Constructor](html/bc30519c-cd9b-27e4-8705-9a43277f0c51.md)

### Properties
[MetafileHeader Properties](html/54c07fa2-450b-f2ea-116b-4c4e90df189b.md)
  - **Bounds Property**: [Details](html/0c6ad3f6-63a8-9352-eba2-c8670cac9d55.md)
```

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

### Name Property (Hierarchy)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Gets or sets the programmatic name of the Hierarchy. This name is used internally for identification and referencing.

```APIDOC
## Name Property (Hierarchy)

### Description
Gets or sets the name of the `Hierarchy`.

### Method
* Property Access (Get/Set)

### Endpoint
N/A (Class Property)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body (for setting)
- **name** (string) - The name of the hierarchy.
```

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

### StartDateChangedEventArgs Class Members

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_SCHEDULE.1/SUMMARY.md

Details about the StartDateChangedEventArgs class, used for handling changes in start dates.

```APIDOC
## StartDateChangedEventArgs Class

### Description
Represents event arguments for changes related to a start date.

### Constructor

#### StartDateChangedEventArgs(DateTime, DateTime)

##### Description
Initializes a new instance of the `StartDateChangedEventArgs` class.

##### Parameters
* **oldStartDate** (DateTime) - Required - The previous start date.
* **newStartDate** (DateTime) - Required - The new start date.

### Properties

#### OldStartDate Property

##### Description
Gets the previous start date.

* **Type**: DateTime
```

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

### RenderingHelper Constructor

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DIAGRAM.1/SUMMARY.md

Provides the constructor for the RenderingHelper class.

```APIDOC
## RenderingHelper Constructor

### Description
Constructor for the RenderingHelper class.

### Method
Constructor

### Endpoint
N/A (Class Constructor)

### Parameters
None

### Request Example
N/A

### Response
N/A
```

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

### FOPTETransform Enumeration

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_DOCIO.1/SUMMARY.md

Details the FOPTETransform enumeration, part of the Syncfusion.DocIO.Utilities namespace. No specific code examples or usage details are available.

```csharp
// No code example available for FOPTETransform Enumeration.
```

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

### Properties

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_TOOLS.1/SUMMARY.md

Documentation for various properties related to UI elements like TextWrap, UseMnemonics, and WidthRestriction.

```APIDOC
## Properties

### Description
Details various properties that control the behavior and appearance of UI elements.

### Endpoint
N/A (Property documentation)

### Properties
- **TextWrap Property**: Controls text wrapping behavior.
- **UseMnemonics Property**: Enables or disables mnemonics.
- **WidthRestrictionEnabled Property**: Enables or disables width restriction.

### Request Example
N/A

### Response
N/A
```

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

### WindowDialogSetting_AddAppointment

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_SCHEDULE.1/SUMMARY.md

Details regarding the WindowDialogSetting_AddAppointment class, including its constructor, methods, and properties.

```APIDOC
## WindowDialogSetting_AddAppointment

### Description
Settings for adding an appointment to a dialog window.

### Constructor
* WindowDialogSetting_AddAppointment()

### Methods
* **SetupChildControlsData**(): void - Sets up data for child controls.

### Properties
#### Path Parameters
- **DialogClientObjectName** (string) - Optional - The name of the dialog's client-side object.
- **DialogDefaultSize** (string) - Optional - The default size of the dialog.
- **DialogResourceFileName** (string) - Optional - The resource file name for the dialog.
- **DialogTitle** (string) - Optional - The title of the dialog.
- **EndDate** (string) - Optional - The end date for the appointment.
- **ResourceID** (string) - Optional - The ID of the resource.
- **StartDate** (string) - Optional - The start date for the appointment.
- **WindowIconSrc** (string) - Optional - The source for the window icon.

### Request Example
```json
{
  "DialogClientObjectName": "myDialog",
  "DialogDefaultSize": "800x600",
  "DialogResourceFileName": "dialog.html",
  "DialogTitle": "Add Appointment",
  "EndDate": "2023-12-31T17:00:00Z",
  "ResourceID": "resource1",
  "StartDate": "2023-12-31T09:00:00Z",
  "WindowIconSrc": "icon.png"
}
```

### Response
#### Success Response (200)
- **WindowDialogSetting_AddAppointment** (object) - An object containing dialog settings.

#### Response Example
```json
{
  "DialogClientObjectName": "myDialog",
  "DialogDefaultSize": "800x600",
  "DialogResourceFileName": "dialog.html",
  "DialogTitle": "Add Appointment",
  "EndDate": "2023-12-31T17:00:00Z",
  "ResourceID": "resource1",
  "StartDate": "2023-12-31T09:00:00Z",
  "WindowIconSrc": "icon.png"
}
```
```

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

### ParentDimension Property (Hierarchy)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Gets the Dimension object to which this Hierarchy belongs. This property establishes the relationship between a hierarchy and its parent dimension.

```APIDOC
## ParentDimension Property (Hierarchy)

### Description
Gets the `Dimension` object that owns this `Hierarchy`.

### Method
* Property Access (Get)

### Endpoint
N/A (Class Property)

### Parameters
None

### Request Example
```json
{
  "operation": "getProperty",
  "propertyName": "ParentDimension"
}
```

### Response
#### Success Response (200)
- **parentDimension** (Dimension) - The parent `Dimension` object.
```

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

### ChartFancyToolTipInfo Methods

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_CHART.1/SUMMARY.md

Documentation for the methods of the ChartFancyToolTipInfo class, including Read and Write.

```APIDOC
## ChartFancyToolTipInfo Methods

### Description
Documentation for the methods of the ChartFancyToolTipInfo class.

### Endpoint
N/A (Class methods)

### Methods
- **Read** (object) - Description of the Read method.
- **Write** (object) - Description of the Write method.
```

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

### Description Property (Hierarchy)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Gets or sets a textual description for the Hierarchy. This property provides additional context or information about the hierarchy.

```APIDOC
## Description Property (Hierarchy)

### Description
Gets or sets the description of the `Hierarchy`.

### Method
* Property Access (Get/Set)

### Endpoint
N/A (Class Property)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body (for setting)
- **description** (string) - The description for the hierarchy.
```

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

### SizeCallback Delegate Documentation

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_DIAGRAM.1/SUMMARY.md

Documentation for the SizeCallback delegate.

```APIDOC
## SizeCallback Delegate

### Description
Represents a callback for size-related events.
```

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

### Properties Property (Hierarchy)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Gets the collection of properties associated with this Hierarchy. Properties can provide additional metadata or configuration options for the hierarchy.

```APIDOC
## Properties Property (Hierarchy)

### Description
Gets the collection of properties for the `Hierarchy`.

### Method
* Property Access (Get)

### Endpoint
N/A (Class Property)

### Parameters
None

### Request Example
```json
{
  "operation": "getProperty",
  "propertyName": "Properties"
}
```

### Response
#### Success Response (200)
- **properties** (PropertyCollection) - A
```

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

### DisplayFolder Property (Hierarchy)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Gets or sets the display folder path for the Hierarchy. This is used to organize hierarchies in a hierarchical view, such as in a UI.

```APIDOC
## DisplayFolder Property (Hierarchy)

### Description
Gets or sets the display folder for the `Hierarchy`.

### Method
* Property Access (Get/Set)

### Endpoint
N/A (Class Property)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body (for setting)
- **displayFolder** (string) - The path to the display folder.
```

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

### IZOrderContainer Interface Methods

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_DIAGRAM.1/SUMMARY.md

Documentation for the methods available within the IZOrderContainer interface.

```APIDOC
## GET /api/interfaces/IZOrderContainer/methods

### Description
Retrieves a list of methods available in the IZOrderContainer interface.

### Method
GET

### Endpoint
/api/interfaces/IZOrderContainer/methods

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **methods** (array) - A list of method names.

#### Response Example
{
  "methods": [
    "BringForward",
    "BringToFront",
    "GetZOrder",
    "SendBackward",
    "SendToBack",
    "SetZOrder"
  ]
}
```

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

### CopyTo Method (DimensionCollection)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Copies all the Dimension objects from the DimensionCollection to a compatible array. The copying starts at a specified index in the destination array.

```APIDOC
## CopyTo Method (DimensionCollection)

### Description
Copies the `Dimension` objects from the `DimensionCollection` to a specified array, starting at a particular index.

### Method
* POST (Conceptual - performs copy operation)

### Endpoint
N/A (Class Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **destinationArray** (Array<Dimension>) - Required - The array to copy the dimensions to.
- **startIndex** (integer) - Required - The zero-based index in `destinationArray` at which copying begins.
```

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

### SixteenthInchMarkupRenderer Class Documentation

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_DIAGRAM.1/SUMMARY.md

Documentation for the SixteenthInchMarkupRenderer class, covering its members and constructor.

```APIDOC
## SixteenthInchMarkupRenderer Class

### Description
Renders markup at a sixteenth-inch resolution.

### Members
- [SixteenthInchMarkupRenderer Members](html/3ef2c0bd-f3be-87bc-51c7-b46c5e0079da.md)

### Constructor
- [SixteenthInchMarkupRenderer Constructor](html/0f51ebb7-4735-ac54-3882-0567182e6900.md)
```

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

### ResourceDictionary API

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_PDF.1/SUMMARY.md

Documentation for the ResourceDictionary class, its members, constructor, and properties.

```APIDOC
## ResourceDictionary API

### Description
Provides access to the members, constructor, and properties of the ResourceDictionary class.

### Endpoints
- `html/857aa329-eb96-80bb-2b84-13b3b45d33cb.md` - ResourceDictionary Members
- `html/c43801d9-b967-92d2-7928-8ec5c097097c.md` - ResourceDictionary Constructor
- `html/d259100e-2149-2b76-66e3-f346d1d50cc0.md` - ResourceDictionary Properties
  - `html/721700b1-dc60-5039-d62d-7212f6c80239.md` - Items Property
  - `html/4614dfa9-d524-ff77-1ffd-e32dc22c0534.md` - Source Property
```

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

### Levels Property (Hierarchy)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Gets the collection of Level objects that constitute this Hierarchy. This property provides access to the different granularities within the hierarchy.

```APIDOC
## Levels Property (Hierarchy)

### Description
Gets the collection of `Level` objects in the `Hierarchy`.

### Method
* Property Access (Get)

### Endpoint
N/A (Class Property)

### Parameters
None

### Request Example
```json
{
  "operation": "getProperty",
  "propertyName": "Levels"
}
```

### Response
#### Success Response (200)
- **levels** (LevelCollection) - A collection of `Level` objects.
```

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

### Caption Property (Hierarchy)

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Gets or sets the user-friendly caption for the Hierarchy. This is often used in UI elements to display the hierarchy's name.

```APIDOC
## Caption Property (Hierarchy)

### Description
Gets or sets the caption of the `Hierarchy`.

### Method
* Property Access (Get/Set)

### Endpoint
N/A (Class Property)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body (for setting)
- **caption** (string) - The new caption for the hierarchy.
```

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

### WebServiceParams Constructor

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MobileMVC/MOBILE_MVC_GRID.1/SUMMARY.md

Details on the constructor for the WebServiceParams class.

```APIDOC
## WebServiceParams Constructor

### Description
Initializes a new instance of the WebServiceParams class.

### Method
GET

### Endpoint
/yakdoli/syncfusion-v11-documents/html/79328543-66ce-0bda-11b9-66985370e0f7.md

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Documentation for the WebServiceParams constructor.

#### Response Example
None
```

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

### KeyConfiguration

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_SCHEDULE.1/SUMMARY.md

Details for the KeyConfiguration class, including its constructor and properties related to appointment actions.

```APIDOC
## KeyConfiguration

### Description
Configuration for keyboard shortcuts related to appointment actions.

### Constructor
* KeyConfiguration()

### Properties
#### Path Parameters
- **CopyAppointment** (string) - Optional - Key combination for copying appointments.
- **CutAppointment** (string) - Optional - Key combination for cutting appointments.
- **Day** (string) - Optional - Key combination for day view.
- **DeleteAppointment** (string) - Optional - Key combination for deleting appointments.
- **EditAppointment** (string) - Optional - Key combination for editing appointments.
- **ExportAppointment** (string) - Optional - Key combination for exporting appointments.
- **FocusKey** (string) - Optional - Key combination for focus.
- **FocusOut** (string) - Optional - Key combination for focus out.
- **HideCalendar** (string) - Optional - Key combination for hiding the calendar.
- **InsertAppointment** (string) - Optional - Key combination for inserting appointments.
- **Month** (string) - Optional - Key combination for month view.
- **MoveTimeCellDown** (string) - Optional - Key combination for moving time cell down.
- **MoveTimeCellLeft** (string) - Optional - Key combination for moving time cell left.
- **MoveTimeCellRight** (string) - Optional - Key combination for moving time cell right.
- **MoveTimeCellUp** (string) - Optional - Key combination for moving time cell up.

### Request Example
```json
{
  "CopyAppointment": "Ctrl+C",
  "CutAppointment": "Ctrl+X",
  "Day": "D",
  "DeleteAppointment": "Del",
  "EditAppointment": "Enter",
  "ExportAppointment": "Ctrl+E",
  "FocusKey": "F",
  "FocusOut": "Esc",
  "HideCalendar": "H",
  "InsertAppointment": "Insert",
  "Month": "M",
  "MoveTimeCellDown": "ArrowDown",
  "MoveTimeCellLeft": "ArrowLeft",
  "MoveTimeCellRight": "ArrowRight",
  "MoveTimeCellUp": "ArrowUp"
}
```

### Response
#### Success Response (200)
- **KeyConfiguration** (object) - An object containing key configuration settings.

#### Response Example
```json
{
  "CopyAppointment": "Ctrl+C",
  "CutAppointment": "Ctrl+X",
  "Day": "D",
  "DeleteAppointment": "Del",
  "EditAppointment": "Enter",
  "ExportAppointment": "Ctrl+E",
  "FocusKey": "F",
  "FocusOut": "Esc",
  "HideCalendar": "H",
  "InsertAppointment": "Insert",
  "Month": "M",
  "MoveTimeCellDown": "ArrowDown",
  "MoveTimeCellLeft": "ArrowLeft",
  "MoveTimeCellRight": "ArrowRight",
  "MoveTimeCellUp": "ArrowUp"
}
```
```

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

### UniqueName Property

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/ASP/ASP.NET_OLAP COMMON.1/SUMMARY.md

Provides access to the UniqueName property of an object. This property is typically used to get a unique identifier for the object within its scope.

```APIDOC
## UniqueName Property

### Description
Gets or sets the unique name of the object.

### Method
* Property Access

### Endpoint
N/A (Class Property)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "operation": "getProperty",
  "propertyName": "UniqueName"
}
```

### Response
#### Success Response (200)
- **uniqueName** (string) - The unique name of the object.

#### Response Example
```json
{
  "uniqueName": "[UniqueNameValue]"
}
```
```

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

### Section API

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/WinForm/WF_PDF.1/SUMMARY.md

Documentation for the Section class, its members, constructor, and properties.

```APIDOC
## Section API

### Description
Provides access to the members, constructor, and properties of the Section class.

### Endpoints
- `html/80d72619-944c-20c5-94de-67598f3c3ff0.md` - Section Members
- `html/29574715-87cb-be16-bfb2-dcd8d1034563.md` - Section Constructor
- `html/c7a71921-45bb-23e0-8d9e-473943631b03.md` - Section Properties
  - `html/64513e12-2e73-8823-0e97-9725c83e9ed0.md` - Items Property
```

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

### ScriptRegisterHelper API

Source: https://github.com/yakdoli/syncfusion-v11-documents/blob/master/ClassRef/MobileMVC/MOBILE_MVC_CHART.1/SUMMARY.md

Helper class for registering script resources. Contains methods for getting and registering script resources in web applications.

```APIDOC
## ScriptRegisterHelper.GetResource

### Description
Gets a script resource based on the provided parameters.

### Method
GET

### Endpoint
/ScriptRegisterHelper/GetResource

### Parameters
#### Query Parameters
- **resourceName** (string) - Required - The name of the resource to retrieve

### Response
#### Success Response (200)
- **resource** (string) - The retrieved script resource

#### Response Example
{
  "resource": "script content here"
}

## ScriptRegisterHelper.RegisterResource

### Description
Registers a script resource within the application context.

### Method
POST

### Endpoint
/ScriptRegisterHelper/RegisterResource

### Parameters
#### Request Body
- **resourceName** (string) - Required - The name of the resource to register
- **resourceContent** (string) - Required - The content of the resource

### Request Example
{
  "resourceName": "example.js",
  "resourceContent": "console.log('Hello World');"
}

### Response
#### Success Response (200)
- **status** (string) - Registration status

#### Response Example
{
  "status": "success"
}
```
Tokens:
Raw