asposediagram.api

asposediagram.api

Class Field

Contains elements that specify functions and formulas inserted in the shape's text.

Constructor Summary
Field()
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.
methodgetDisplayValue()
Gets the formatted string value of this field .
methodgetEditMode()
Reserved for future use.
methodgetFormat()
Format element specifies the formatting for a text field that is a string, number, date or time, duration, or currency. The text field type is specified in the corresponding Type element.
methodgetIX()
method
setIX(value)
           The zero-based index of the element within its parent element.
methodgetObjectKind()
Indicates the type of text field.
methodgetType()
Type specifies a data type for the text field value.
methodgetUICat()
Specifies the category of an inserted field in versions of Microsoft Visio earlier than Visio 2000.
methodgetUICod()
Specifies the code of an inserted field in versions of Microsoft Visio earlier than Visio 2000.
methodgetUIFmt()
Specifies the format of an inserted field in versions of Microsoft Visio earlier than Visio 2000.
methodgetValue()
It contains the value for a text field.
 
Method Summary
methoddeepClone()
Creates deep copy of this instance.
 

    • Constructor Detail

      • Field

        Field()
        Constructor.

    • Property Getters/Setters Detail

      • getIX/setIX : int 

        int getIX() / setIX(value)
        The zero-based index 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.

      • getValue : Value 

        Value getValue()
        It contains the value for a text field.

      • getDisplayValue : String 

        String getDisplayValue()
        Gets the formatted string value of this field .

      • getFormat : Value 

        Value getFormat()
        Format element specifies the formatting for a text field that is a string, number, date or time, duration, or currency. The text field type is specified in the corresponding Type element.

      • getType : TypeField 

        TypeField getType()
        Type specifies a data type for the text field value.

      • getUICat : DoubleValue 

        DoubleValue getUICat()
        Specifies the category of an inserted field in versions of Microsoft Visio earlier than Visio 2000.

      • getUICod : DoubleValue 

        DoubleValue getUICod()
        Specifies the code of an inserted field in versions of Microsoft Visio earlier than Visio 2000.

      • getUIFmt : DoubleValue 

        DoubleValue getUIFmt()
        Specifies the format of an inserted field in versions of Microsoft Visio earlier than Visio 2000.

      • getCalendar : Calendar 

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

    • Method Detail

      • deepClone

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