getControlProperties()

Pixelsilk API function to get the properties of a control--requires the advanced-admin-access permission

Parameters:
controlId: the unique identifier of the control

Output:
The function getControlProperties returns a collection of key/value pairs. Each key is the name of a property; the value associated with a key is that property's value.

C# Example:

Guid controlId = <control's id>;
IDictionary<string, string> properties = GetControlProperties(id);

Note the capital first letter of the C# method.

HTTP Example:

Request Headers:
POST /api2/getControlProperties HTTP/1.1
HOST: www.example.com
Content-Length: 123
Content-Type: application/x-www-form-urlencoded
Cookie: auth=64583D51B5F6...2B474F813863

Request Data:
Unencoded Data:
json={
"controlId":"d83198a3-1e97-4d4c-b9d6-3b78d4649f43"
}&token=7AdbNHZQBtwc...RPTEK8UvSUQ=

Url-encoded Data:
json=%7b%0d%0a+++...%22%0d%0a%7d&token=7AdbNHZQBtwc...TEK8UvSUQ%3d

Response Headers:
HTTP/1.1 200 OK
Set-Cookie: auth=ADA0EE4C1AE1...56033DF6CE1; path=/
Content-Type: text/javascript; charset=UTF-8
Content-Length: 65

Response Data:
{"Inheritance":"SingleInstance","PageList":"","IsInclude":"True"}

JavaScript Example:

Method Call:
pixelsilk2.getControlProperties(input, callback)

Input Object:
{
    "controlId":"70de7e42-b90f-4de0-bdc1-5c3ae4b8cbe1"
}

Returned Data:
{
    "Inheritance":"SingleInstance",
    "PageList":"",
    "IsInclude":"True"
}

Back to Controls »