DocumentProperties
Inheritance: java.lang.Object
public class DocumentProperties
Contains document property elements such as the document’s title, author, and so on.
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getAlternateNames() | Specifies the alternate names for a document. |
| getBuildNumberCreated() | Contains the full build number of the instance used to create the document. |
| getBuildNumberEdited() | Contains the build number of the instance last used to edit the document. |
| getCategory() | Specifies the descriptive text for the type of drawing, such as flowchart or office layout. |
| getClass() | |
| getCompany() | Contains user-entered information identifying the company creating the drawing or the company the drawing is being created for. |
| getCreator() | Identifies who created or last updated the file. |
| getCustomProps() | Collection of CustomProp. |
| getDesc() | Contains a descriptive text string for a document. |
| getHyperlinkBase() | Contains the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). |
| getKeywords() | Contains a text string that identifies topics or other important information about the file, such as project name, client name, or version number. |
| getLanguage() | Specifies the language |
| getManager() | Contains a user-entered text string identifying the person in charge of the project or department. |
| getPreviewPicture() | Contains a metafile stream that serves as a preview of the document. |
| getSubject() | Contains a user-defined text string that describes the contents of the document. |
| getTemplate() | Contains a string value specifying the file name of the template from which the document was created. |
| getTimeCreated() | Contains date and time value indicating when the document was created. |
| getTimeEdited() | Contains date and time value indicating when the document was last edited. |
| getTimePrinted() | Contains date and time value indicating when the document was last printed. |
| getTimeSaved() | Contains date and time value indicating when the document was last saved. |
| getTitle() | Contains a user-defined text string that serves as a descriptive title for the document. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setAlternateNames(String value) | For the description of this property, please see getAlternateNames() |
| setBuildNumberCreated(String value) | For the description of this property, please see getBuildNumberCreated() |
| setBuildNumberEdited(String value) | For the description of this property, please see getBuildNumberEdited() |
| setCategory(String value) | For the description of this property, please see getCategory() |
| setCompany(String value) | For the description of this property, please see getCompany() |
| setCreator(String value) | For the description of this property, please see getCreator() |
| setDesc(String value) | For the description of this property, please see getDesc() |
| setHyperlinkBase(String value) | For the description of this property, please see getHyperlinkBase() |
| setKeywords(String value) | For the description of this property, please see getKeywords() |
| setLanguage(String value) | For the description of this property, please see getLanguage() |
| setManager(String value) | For the description of this property, please see getManager() |
| setPreviewPicture(byte[] value) | For the description of this property, please see getPreviewPicture() |
| setSubject(String value) | For the description of this property, please see getSubject() |
| setTemplate(String value) | For the description of this property, please see getTemplate() |
| setTimeCreated(DateTime value) | For the description of this property, please see getTimeCreated() |
| setTimeEdited(DateTime value) | For the description of this property, please see getTimeEdited() |
| setTimePrinted(DateTime value) | For the description of this property, please see getTimePrinted() |
| setTimeSaved(DateTime value) | For the description of this property, please see getTimeSaved() |
| setTitle(String value) | For the description of this property, please see getTitle() |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getAlternateNames()
public String getAlternateNames()
Specifies the alternate names for a document.
Returns: java.lang.String
getBuildNumberCreated()
public String getBuildNumberCreated()
Contains the full build number of the instance used to create the document.
Returns: java.lang.String
getBuildNumberEdited()
public String getBuildNumberEdited()
Contains the build number of the instance last used to edit the document.
Returns: java.lang.String
getCategory()
public String getCategory()
Specifies the descriptive text for the type of drawing, such as flowchart or office layout. This text can also be entered in the Microsoft Visio user interface in the Category box in the Properties dialog box.
Returns: java.lang.String
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCompany()
public String getCompany()
Contains user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters.
Returns: java.lang.String
getCreator()
public String getCreator()
Identifies who created or last updated the file. The maximum length is 63 characters.
Returns: java.lang.String
getCustomProps()
public CustomPropCollection getCustomProps()
Collection of CustomProp.
Returns: CustomPropCollection
getDesc()
public String getDesc()
Contains a descriptive text string for a document. Use this element to store important information about the document, such as its purpose, recent changes, or pending changes. The maximum is 191 characters.
Returns: java.lang.String
getHyperlinkBase()
public String getHyperlinkBase()
Contains the path to be used for relative hyperlinks (hyperlinks for which the linked file location is described in relation to the Microsoft Visio diagram). By default, a hyperlink path is relative to the current document unless a different path is specified in this element. Maximum length is 256 characters.
Returns: java.lang.String
getKeywords()
public String getKeywords()
Contains a text string that identifies topics or other important information about the file, such as project name, client name, or version number. The maximum string length is 63 characters.
Returns: java.lang.String
getLanguage()
public String getLanguage()
Specifies the language
setLanguage("en-GB");
setLanguage("en-US");
Returns: java.lang.String
getManager()
public String getManager()
Contains a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.
Returns: java.lang.String
getPreviewPicture()
public byte[] getPreviewPicture()
Contains a metafile stream that serves as a preview of the document.
Returns: byte[]
getSubject()
public String getSubject()
Contains a user-defined text string that describes the contents of the document. Maximum length is 63 characters.
Returns: java.lang.String
getTemplate()
public String getTemplate()
Contains a string value specifying the file name of the template from which the document was created.
Returns: java.lang.String
getTimeCreated()
public DateTime getTimeCreated()
Contains date and time value indicating when the document was created.
Returns: DateTime
getTimeEdited()
public DateTime getTimeEdited()
Contains date and time value indicating when the document was last edited.
Returns: DateTime
getTimePrinted()
public DateTime getTimePrinted()
Contains date and time value indicating when the document was last printed.
Returns: DateTime
getTimeSaved()
public DateTime getTimeSaved()
Contains date and time value indicating when the document was last saved.
Returns: DateTime
getTitle()
public String getTitle()
Contains a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters.
Returns: java.lang.String
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAlternateNames(String value)
public void setAlternateNames(String value)
For the description of this property, please see getAlternateNames()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setBuildNumberCreated(String value)
public void setBuildNumberCreated(String value)
For the description of this property, please see getBuildNumberCreated()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setBuildNumberEdited(String value)
public void setBuildNumberEdited(String value)
For the description of this property, please see getBuildNumberEdited()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCategory(String value)
public void setCategory(String value)
For the description of this property, please see getCategory()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCompany(String value)
public void setCompany(String value)
For the description of this property, please see getCompany()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCreator(String value)
public void setCreator(String value)
For the description of this property, please see getCreator()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setDesc(String value)
public void setDesc(String value)
For the description of this property, please see getDesc()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setHyperlinkBase(String value)
public void setHyperlinkBase(String value)
For the description of this property, please see getHyperlinkBase()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setKeywords(String value)
public void setKeywords(String value)
For the description of this property, please see getKeywords()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setLanguage(String value)
public void setLanguage(String value)
For the description of this property, please see getLanguage()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setManager(String value)
public void setManager(String value)
For the description of this property, please see getManager()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setPreviewPicture(byte[] value)
public void setPreviewPicture(byte[] value)
For the description of this property, please see getPreviewPicture()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte[] |
setSubject(String value)
public void setSubject(String value)
For the description of this property, please see getSubject()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setTemplate(String value)
public void setTemplate(String value)
For the description of this property, please see getTemplate()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setTimeCreated(DateTime value)
public void setTimeCreated(DateTime value)
For the description of this property, please see getTimeCreated()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setTimeEdited(DateTime value)
public void setTimeEdited(DateTime value)
For the description of this property, please see getTimeEdited()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setTimePrinted(DateTime value)
public void setTimePrinted(DateTime value)
For the description of this property, please see getTimePrinted()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setTimeSaved(DateTime value)
public void setTimeSaved(DateTime value)
For the description of this property, please see getTimeSaved()
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setTitle(String value)
public void setTitle(String value)
For the description of this property, please see getTitle()
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 |