asposediagram.api

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
methodgetAlternateNames()
method
           Specifies the alternate names for a document.
methodgetBuildNumberCreated()
method
           Contains the full build number of the instance used to create the document.
methodgetBuildNumberEdited()
method
           Contains the build number of the instance last used to edit the document.
methodgetCategory()
method
           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.
methodgetCompany()
method
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.
methodgetCreator()
method
setCreator(value)
           Identifies who created or last updated the file. The maximum length is 63 characters.
methodgetCustomProps()
Collection of CustomProp.
methodgetDesc()
method
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.
methodgetHyperlinkBase()
method
           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.
methodgetKeywords()
method
           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.
methodgetLanguage()
method
           Specifies the language
methodgetManager()
method
setManager(value)
           Contains a user-entered text string identifying the person in charge of the project or department. The maximum length is 63 characters.
methodgetPreviewPicture()
method
           Contains a metafile stream that serves as a preview of the document.
methodgetSubject()
method
setSubject(value)
           Contains a user-defined text string that describes the contents of the document. Maximum length is 63 characters.
methodgetTemplate()
method
           Contains a string value specifying the file name of the template from which the document was created.
methodgetTimeCreated()
method
           Contains date and time value indicating when the document was created.
methodgetTimeEdited()
method
           Contains date and time value indicating when the document was last edited.
methodgetTimePrinted()
method
           Contains date and time value indicating when the document was last printed.
methodgetTimeSaved()
method
           Contains date and time value indicating when the document was last saved.
methodgetTitle()
method
setTitle(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 

        String getTitle() / 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 

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

        String getCreator() / setCreator(value)
        
        Identifies who created or last updated the file. The maximum length is 63 characters.
      • getManager/setManager : String 

        String getManager() / 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 

        String getCompany() / 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 

        String getCategory() / 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 

        String getKeywords() / 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 

        String getLanguage() / setLanguage(value)
        
        Specifies the language
      • getDesc/setDesc : String 

        String getDesc() / 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 

        String getHyperlinkBase() / 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 

        String getAlternateNames() / setAlternateNames(value)
        
        Specifies the alternate names for a document.
      • getTemplate/setTemplate : String 

        String getTemplate() / setTemplate(value)
        
        Contains a string value specifying the file name of the template from which the document was created.
      • getBuildNumberCreated/setBuildNumberCreated : String 

        String getBuildNumberCreated() / setBuildNumberCreated(value)
        
        Contains the full build number of the instance used to create the document.
      • getBuildNumberEdited/setBuildNumberEdited : String 

        String getBuildNumberEdited() / setBuildNumberEdited(value)
        
        Contains the build number of the instance last used to edit the document.
      • getPreviewPicture/setPreviewPicture : byte[] 

        byte[] getPreviewPicture() / setPreviewPicture(value)
        
        Contains a metafile stream that serves as a preview of the document.
      • getTimeCreated/setTimeCreated : DateTime 

        DateTime getTimeCreated() / setTimeCreated(value)
        
        Contains date and time value indicating when the document was created.
      • getTimeSaved/setTimeSaved : DateTime 

        DateTime getTimeSaved() / setTimeSaved(value)
        
        Contains date and time value indicating when the document was last saved.
      • getTimeEdited/setTimeEdited : DateTime 

        DateTime getTimeEdited() / setTimeEdited(value)
        
        Contains date and time value indicating when the document was last edited.
      • getTimePrinted/setTimePrinted : DateTime 

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