Share via


Sys.Component id Property

Gets or sets the ID of the current Component object.

Note

To get or set property values for client API properties, you must call property accessor methods that are named with the get_ and set_ prefixes. For example, to get or set a value for a property such as cancel, you call the get_cancel or set_cancel methods.

var _id = aComponent.get_id();
c.set_id(value);

Arguments

  • value
    A string that contains the ID of the component.

Return Value

The string that is the ID of the component.

Exceptions

Exception type

Condition

Sys.ArgumentException

(Debug) value is null or an empty string ("").

- or -

value starts or ends with a space character.

Remarks

The id property must be set before the component is registered with the application.

See Also

Tasks

Creating Custom Non-Visual Client Components

Reference

Sys.Component Class

Concepts

Defining Custom Component Properties and Raising PropertyChanged Events

Other Resources

Language Reference