Prop

Prop class

Contains elements for defining custom properties and elements for associating data with a shape.

Constructors

NameDescription
PropConstructor.

Properties

NameTypeDescription
ValueValueContains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document
NameStringThe name of the element.
NameUStringThe universal name of the element.
IXintThe zero-based index of the element within its parent element.
IDintThe unique ID of the element within its parent element.
DelintA flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted loca
PromptStr2ValuePrompt element specifies descriptive or instructional text that appears to users in the Custom Properties dialog box whe
LabelStr2ValueSpecifies the label that appears to users in the Custom Properties dialog box.
FormatStrValueFormat element specifies the formatting of a custom property that is a string, fixed list, number, variable list, date o
SortKeyStr2ValueIt specifies a key that determines the order in which custom properties are listed in the application’s user interface.
TypeTypePropType specifies a data type for the custom property value.
InvisibleBoolValueInvisible element specifies whether the custom property is visible in the Custom Properties dialog box in Microsoft Visi
VerifyBoolValueSpecifies whether the user is queried to enter custom property information for a shape when an instance is created or th
LangIDIntValueIndicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered.
CalendarCalendarDetermines the calendar that is used for custom properties, text fields, and element formulas.

Methods

NameDescription
deepCloneCreates deep copy of this instance.

Prop()

Constructor.

Prop.Value property

Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document.

Type: Value

Prop.Name property

The name of the element.

Type: String

Prop.NameU property

The universal name of the element.

Type: String

Prop.IX property

The zero-based index of the element within its parent element.

Type: int

Prop.ID property

The unique ID of the element within its parent element.

Type: int

Prop.Del property

A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.

Type: int

Prop.Prompt property

Prompt element specifies descriptive or instructional text that appears to users in the Custom Properties dialog box when the property is selected. This text also appears as a tool tip when the mouse pointer is paused over the property in the Custom Properties window.

Type: Str2Value

Prop.Label property

Specifies the label that appears to users in the Custom Properties dialog box.

Type: Str2Value

Prop.Format property

Format element specifies the formatting of a custom property that is a string, fixed list, number, variable list, date or time, duration, or currency. The custom property type is specified in the corresponding Type element.

Type: StrValue

Prop.SortKey property

It specifies a key that determines the order in which custom properties are listed in the application’s user interface.

Type: Str2Value

Prop.Type property

Type specifies a data type for the custom property value.

Type: TypeProp

Prop.Invisible property

Invisible element specifies whether the custom property is visible in the Custom Properties dialog box in Microsoft Visio.

Type: BoolValue

Prop.Verify property

Specifies whether the user is queried to enter custom property information for a shape when an instance is created or the shape is duplicated or copied.

Type: BoolValue

Prop.LangID property

Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered.

Type: IntValue

Prop.Calendar property

Determines the calendar that is used for custom properties, text fields, and element formulas.

Type: Calendar

deepClone()

Creates deep copy of this instance.