Prop
Inheritance: java.lang.Object
public class Prop
Contains elements for defining custom properties and elements for associating data with a shape.
Constructors
| Constructor | Description |
|---|---|
| Prop() | Constructor. |
Methods
| Method | Description |
|---|---|
| deepClone() | Creates deep copy of this instance. |
| equals(Object arg0) | |
| getCalendar() | Determines the calendar that is used for custom properties, text fields, and element formulas. |
| getClass() | |
| getDel() | A flag indicating whether the element has been deleted locally. |
| 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. |
| getID() | The unique ID of the element within its parent element. |
| getIX() | The zero-based index of the element within its parent element. |
| getInvisible() | Invisible element specifies whether the custom property is visible in the Custom Properties dialog box in Microsoft Visio. |
| getLabel() | Specifies the label that appears to users in the Custom Properties dialog box. |
| getLangID() | Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered. |
| getName() | The name of the element. |
| getNameU() | The universal name of the element. |
| getPrompt() | Prompt element specifies descriptive or instructional text that appears to users in the Custom Properties dialog box when the property is selected. |
| getSortKey() | It specifies a key that determines the order in which custom properties are listed in the application’s user interface. |
| getType() | Type specifies a data type for the custom property value. |
| getValue() | Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document. |
| 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. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setDel(int value) | For the description of this property, please see getDel() |
| setID(int value) | For the description of this property, please see getID() |
| setIX(int value) | For the description of this property, please see getIX() |
| setName(String value) | For the description of this property, please see getName() |
| setNameU(String value) | For the description of this property, please see getNameU() |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
Prop()
public Prop()
Constructor.
deepClone()
public Prop deepClone()
Creates deep copy of this instance.
Returns: Prop -
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getCalendar()
public Calendar getCalendar()
Determines the calendar that is used for custom properties, text fields, and element formulas.
Returns: Calendar
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getDel()
public int getDel()
A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally.
Returns: int
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.
Returns: StrValue
getID()
public int getID()
The unique ID of the element within its parent element.
Returns: int
getIX()
public int getIX()
The zero-based index of the element within its parent element.
Returns: int
getInvisible()
public BoolValue getInvisible()
Invisible element specifies whether the custom property is visible in the Custom Properties dialog box in Microsoft Visio.
Returns: BoolValue
getLabel()
public Str2Value getLabel()
Specifies the label that appears to users in the Custom Properties dialog box.
Returns: Str2Value
getLangID()
public IntValue getLangID()
Indicates the locale ID (LCID) of the language in which the cell formula, text, custom property, or comment was entered.
Returns: IntValue
getName()
public String getName()
The name of the element.
Returns: java.lang.String
getNameU()
public String getNameU()
The universal name of the element.
Returns: java.lang.String
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.
Returns: Str2Value
getSortKey()
public Str2Value getSortKey()
It specifies a key that determines the order in which custom properties are listed in the application’s user interface.
Returns: Str2Value
getType()
public TypeProp getType()
Type specifies a data type for the custom property value.
Returns: TypeProp
getValue()
public Value getValue()
Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document.
Returns: Value
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.
Returns: BoolValue
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setDel(int value)
public void setDel(int value)
For the description of this property, please see getDel()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setID(int value)
public void setID(int value)
For the description of this property, please see getID()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setIX(int value)
public void setIX(int value)
For the description of this property, please see getIX()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setName(String value)
public void setName(String value)
For the description of this property, please see getName()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setNameU(String value)
public void setNameU(String value)
For the description of this property, please see getNameU()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |