aspose.diagram
Class DocumentProperties

Contains document property elements such as the document's title, author, and so on.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("Introduction.vsdx");

// Set some summary information about the diagram
diagram.getDocumentProps().setCreator("Farhan");
diagram.getDocumentProps().setCompany("Aspose");
diagram.getDocumentProps().setCategory("Drawing 2D");
diagram.getDocumentProps().setManager("Sergey Polshkov");
diagram.getDocumentProps().setTitle("Aspose Title");
diagram.getDocumentProps().setTimeCreated(aspose.diagram.DateTime.getNow());
diagram.getDocumentProps().setSubject("Visio Diagram");
diagram.getDocumentProps().setTemplate("Aspose Template");

// Write the updated file to the disk in VSDX file format
diagram.save("out-SetVisioProperties_Out.vsdx", aspose.diagram.SaveFileFormat.VSDX);

Property Getters/Setters Summary
functiongetAlternateNames()
functionsetAlternateNames(value)
           Specifies the alternate names for a document.
functiongetBuildNumberCreated()
functionsetBuildNumberCreated(value)
           Contains the full build number of the instance used to create the document.
functiongetBuildNumberEdited()
functionsetBuildNumberEdited(value)
           Contains the build number of the instance last used to edit the document.
functiongetCategory()
functionsetCategory(value)
           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.
functiongetCompany()
functionsetCompany(value)
           Contains user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters.
functiongetCreator()
functionsetCreator(value)
           Identifies who created or last updated the file. The maximum length is 63 characters.
functiongetCustomProps()
           Collection of CustomProp.
functiongetDesc()
functionsetDesc(value)
           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.
functiongetHyperlinkBase()
functionsetHyperlinkBase(value)
           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.
functiongetKeywords()
functionsetKeywords(value)
           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.
functiongetLanguage()
functionsetLanguage(value)
           Specifies the language
functiongetManager()
functionsetManager(value)
           Contains a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.
functiongetPreviewPicture()
functionsetPreviewPicture(value)
           Contains a metafile stream that serves as a preview of the document.
functiongetSubject()
functionsetSubject(value)
           Contains a user-defined text string that describes the contents of the document. Maximum length is 63 characters.
functiongetTemplate()
functionsetTemplate(value)
           Contains a string value specifying the file name of the template from which the document was created.
functiongetTimeCreated()
           Contains date and time value indicating when the document was created.
functiongetTimeEdited()
           Contains date and time value indicating when the document was last edited.
functiongetTimePrinted()
           Contains date and time value indicating when the document was last printed.
functiongetTimeSaved()
           Contains date and time value indicating when the document was last saved.
functiongetTitle()
functionsetTitle(value)
           Contains a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters.
 

Property Getters/Setters Detail

getTitle/setTitle : String 

function getTitle() / function setTitle(value)
Contains a user-defined text string that serves as a descriptive title for the document. Maximum length is 63 characters.

getSubject/setSubject : String 

function getSubject() / function setSubject(value)
Contains a user-defined text string that describes the contents of the document. Maximum length is 63 characters.

getCreator/setCreator : String 

function getCreator() / function setCreator(value)
Identifies who created or last updated the file. The maximum length is 63 characters.

getManager/setManager : String 

function getManager() / function setManager(value)
Contains a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.

getCompany/setCompany : String 

function getCompany() / function setCompany(value)
Contains user-entered information identifying the company creating the drawing or the company the drawing is being created for. Maximum length is 63 characters.

getCategory/setCategory : String 

function getCategory() / function setCategory(value)
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.

getKeywords/setKeywords : String 

function getKeywords() / function setKeywords(value)
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.

getLanguage/setLanguage : String 

function getLanguage() / function setLanguage(value)
Specifies the language

getDesc/setDesc : String 

function getDesc() / function setDesc(value)
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.

getHyperlinkBase/setHyperlinkBase : String 

function getHyperlinkBase() / function setHyperlinkBase(value)
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.

getAlternateNames/setAlternateNames : String 

function getAlternateNames() / function setAlternateNames(value)
Specifies the alternate names for a document.

getTemplate/setTemplate : String 

function getTemplate() / function setTemplate(value)
Contains a string value specifying the file name of the template from which the document was created.

getBuildNumberCreated/setBuildNumberCreated : String 

function getBuildNumberCreated() / function setBuildNumberCreated(value)
Contains the full build number of the instance used to create the document.

getBuildNumberEdited/setBuildNumberEdited : String 

function getBuildNumberEdited() / function setBuildNumberEdited(value)
Contains the build number of the instance last used to edit the document.

getPreviewPicture/setPreviewPicture : byte[] 

function getPreviewPicture() / function setPreviewPicture(value)
Contains a metafile stream that serves as a preview of the document.

getTimeCreated : DateTime 

function getTimeCreated()
Contains date and time value indicating when the document was created.

getTimeSaved : DateTime 

function getTimeSaved()
Contains date and time value indicating when the document was last saved.

getTimeEdited : DateTime 

function getTimeEdited()
Contains date and time value indicating when the document was last edited.

getTimePrinted : DateTime 

function getTimePrinted()
Contains date and time value indicating when the document was last printed.

getCustomProps : CustomPropCollection 

function getCustomProps()
Collection of CustomProp.

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