com.aspose.diagram
Class Prop

java.lang.Object
    extended by com.aspose.diagram.Prop

public class Prop 
extends java.lang.Object

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


Constructor Summary
Prop()
           Constructor.
 
Property Getters/Setters Summary
CalendargetCalendar()
           Determines the calendar that is used for custom properties, text fields, and element formulas.
intgetDel()
voidsetDel(int)
           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.
StrValuegetFormat()
           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.
intgetID()
voidsetID(int)
           The unique ID of the element within its parent element.
BoolValuegetInvisible()
           Invisible element specifies whether the custom property is visible in the Custom Properties dialog box in Microsoft Visio.
intgetIX()
voidsetIX(int)
           The zero-based index of the element within its parent element.
Str2ValuegetLabel()
           Specifies the label that appears to users in the Custom Properties dialog box.
IntValuegetLangID()
           Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered.
java.lang.StringgetName()
voidsetName(java.lang.String)
           The name of the element.
java.lang.StringgetNameU()
voidsetNameU(java.lang.String)
           The universal name of the element.
Str2ValuegetPrompt()
           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.
Str2ValuegetSortKey()
           It specifies a key that determines the order in which custom properties are listed in the application's user interface.
TypePropgetType()
           Type specifies a data type for the custom property value.
ValuegetValue()
           Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document.
BoolValuegetVerify()
           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
PropdeepClone()
           Creates deep copy of this instance.
 

Constructor Detail

Prop

public Prop()
Constructor.

Property Getters/Setters Detail

getValue

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

getName/setName

public java.lang.String getName() / public void setName(java.lang.String value)
The name of the element.

getNameU/setNameU

public java.lang.String getNameU() / public void setNameU(java.lang.String value)
The universal name of the element.

getIX/setIX

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

getID/setID

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

getDel/setDel

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

public 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

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

getFormat

public 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

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

getType

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

getInvisible

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

getVerify

public 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

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

getCalendar

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

Method Detail

deepClone

public Prop deepClone()
              throws java.lang.Exception
Creates deep copy of this instance.
Returns:

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