asposediagram.api

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

Constructor Summary
Prop()
Constructor.
 
Property Getters/Setters Summary
methodgetCalendar()
Determines the calendar that is used for custom properties, text fields, and element formulas.
methodgetDel()
method
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.
methodgetFormat()
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.
methodgetID()
method
setID(value)
           The unique ID of the element within its parent element.
methodgetInvisible()
Invisible element specifies whether the custom property is visible in the Custom Properties dialog box in Microsoft Visio.
methodgetIX()
method
setIX(value)
           The zero-based index of the element within its parent element.
methodgetLabel()
Specifies the label that appears to users in the Custom Properties dialog box.
methodgetLangID()
Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered.
methodgetName()
method
setName(value)
           The name of the element.
methodgetNameU()
method
setNameU(value)
           The universal name of the element.
methodgetPrompt()
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.
methodgetSortKey()
It specifies a key that determines the order in which custom properties are listed in the application's user interface.
methodgetType()
Type specifies a data type for the custom property value.
methodgetValue()
Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document.
methodgetVerify()
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
methoddeepClone()
Creates deep copy of this instance.
 

    • Constructor Detail

      • Prop

        Prop()
        Constructor.
    • Property Getters/Setters Detail

      • getValue : Value 

        Value getValue()
        
        Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document.
      • getName/setName : String 

        String getName() / setName(value)
        
        The name of the element.
      • getNameU/setNameU : String 

        String getNameU() / setNameU(value)
        
        The universal name of the element.
      • getIX/setIX : int 

        int getIX() / setIX(value)
        
        The zero-based index of the element within its parent element.
      • getID/setID : int 

        int getID() / setID(value)
        
        The unique ID of the element within its parent element.
      • getDel/setDel : int 

        int getDel() / 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 

        Str2Value 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 

        Str2Value getLabel()
        
        Specifies the label that appears to users in the Custom Properties dialog box.
      • getFormat : StrValue 

        StrValue 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 

        Str2Value getSortKey()
        
        It specifies a key that determines the order in which custom properties are listed in the application's user interface.
      • getType : TypeProp 

        TypeProp getType()
        
        Type specifies a data type for the custom property value.
      • getInvisible : BoolValue 

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

        BoolValue 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 

        IntValue getLangID()
        
        Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered.
      • getCalendar : Calendar 

        Calendar getCalendar()
        
        Determines the calendar that is used for custom properties, text fields, and element formulas.
    • Method Detail

      • deepClone

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