aspose.diagram
Class Prop

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

Constructor Summary
Prop()
           Constructor.
 
Property Getters/Setters Summary
functiongetCalendar()
           Determines the calendar that is used for custom properties, text fields, and element formulas.
functiongetDel()
functionsetDel(value)
           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.
functiongetFormat()
           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.
functiongetID()
functionsetID(value)
           The unique ID of the element within its parent element.
functiongetInvisible()
           Invisible element specifies whether the custom property is visible in the Custom Properties dialog box in Microsoft Visio.
functiongetIX()
functionsetIX(value)
           The zero-based index of the element within its parent element.
functiongetLabel()
           Specifies the label that appears to users in the Custom Properties dialog box.
functiongetLangID()
           Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered.
functiongetName()
functionsetName(value)
           The name of the element.
functiongetNameU()
functionsetNameU(value)
           The universal name of the element.
functiongetPrompt()
           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.
functiongetSortKey()
           It specifies a key that determines the order in which custom properties are listed in the application's user interface.
functiongetType()
           Type specifies a data type for the custom property value.
functiongetValue()
           Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document.
functiongetVerify()
           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.
 
Method Summary
functiondeepClone()
           Creates deep copy of this instance.
 

Constructor Detail

Prop

function Prop()
Constructor.

Property Getters/Setters Detail

getValue : Value 

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

getName/setName : String 

function getName() / function setName(value)
The name of the element.

getNameU/setNameU : String 

function getNameU() / function setNameU(value)
The universal name of the element.

getIX/setIX : Number 

function getIX() / function setIX(value)
The zero-based index of the element within its parent element.

getID/setID : Number 

function getID() / function setID(value)
The unique ID of the element within its parent element.

getDel/setDel : Number 

function getDel() / function setDel(value)
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.

getPrompt : Str2Value 

function getPrompt()
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.

getLabel : Str2Value 

function getLabel()
Specifies the label that appears to users in the Custom Properties dialog box.

getFormat : StrValue 

function getFormat()
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.

getSortKey : Str2Value 

function getSortKey()
It specifies a key that determines the order in which custom properties are listed in the application's user interface.

getType : TypeProp 

function getType()
Type specifies a data type for the custom property value.

getInvisible : BoolValue 

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

getVerify : BoolValue 

function getVerify()
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.

getLangID : IntValue 

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

getCalendar : Calendar 

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

Method Detail

deepClone

function deepClone()
Creates deep copy of this instance.
Returns:

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.