asposediagram.api

Class DocumentSettings

Contains elements that specify document settings.

Example:

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

diagram = new aspose.diagram.Diagram("ProtectAndUnprotect.vsd");

diagram.getDocumentSettings().setProtectBkgnds(aspose.diagram.BOOL.TRUE);
diagram.getDocumentSettings().setProtectMasters(aspose.diagram.BOOL.TRUE);
diagram.getDocumentSettings().setProtectShapes(aspose.diagram.BOOL.TRUE);
diagram.getDocumentSettings().setProtectStyles(aspose.diagram.BOOL.TRUE);

diagram.save("out-VisioDiagramProtection.vdx", aspose.diagram.SaveFileFormat.VDX);

Property Getters/Setters Summary
methodgetAttachedToolbars()
method
           A MIME (Multipurpose Internet Mail Extensions) encoded Microsoft Visio user interface (VSU) file representing custom toolbars.
methodgetCustomMenusFile()
method
           Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom menus and accelerators for a document.
methodgetCustomToolbarsFile()
method
           Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom toolbars and status bars for a document.
methodgetDefaultFillStyle()
method
           Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherits its fill style from the specified StyleSheet element.
methodgetDefaultGuideStyle()
method
           Specifies the ID of a StyleSheet element. The next time the user creates a guide, the guide inherits its guide style from the specified StyleSheet element.
methodgetDefaultLineStyle()
method
           Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherits its line style from the specified StyleSheet element.
methodgetDefaultTextStyle()
method
           Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherits its text style from the specified StyleSheet element.
methodgetDynamicGridEnabled()
method
           Specifies whether the dynamic grid feature is enabled for a document or window. The value of the property is BOOL integer constant.
methodgetGlueSettings()
method
           Specifies the objects that shapes glue to when glue is enabled in the document. The value of the property is GlueSettings integer constant.
methodgetProtectBkgnds()
method
           Specifies whether the user is prevented from deleting or editing background pages. The value of the property is BOOL integer constant.
methodgetProtectMasters()
method
           Specifies whether the user is prevented from creating, editing, or deleting masters. Regardless of this setting, the user can still create instances of masters. The value of the property is BOOL integer constant.
methodgetProtectShapes()
method
           Specifies whether the user is prevented from selecting shapes that have their LockSelect element set to 1. The value of the property is BOOL integer constant.
methodgetProtectStyles()
method
           Specifies whether the user is prevented from creating or editing styles. However, regardless of this setting, the user can still apply styles. The value of the property is BOOL integer constant.
methodgetSnapAngles()
method
           Contains a collection of SnapAngle elements.
methodgetSnapExtensions()
method
           Specifies whether a specific snap extension setting is enabled or disabled for the active window. The value of the property is SnapExtensions integer constant.
methodgetSnapSettings()
method
           Specifies the objects that shapes snap to when snap is active in the window. The value of the property is SnapSettings integer constant.
methodgetTopPage()
method
setTopPage(value)
           Specifies the ID of the page that should be displayed when the document is opened by Microsoft Visio.
 

    • Property Getters/Setters Detail

      • getTopPage/setTopPage : int 

        int getTopPage() / setTopPage(value)
        
        Specifies the ID of the page that should be displayed when the document is opened by Microsoft Visio.
      • getDefaultTextStyle/setDefaultTextStyle : int 

        int getDefaultTextStyle() / setDefaultTextStyle(value)
        
        Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherits its text style from the specified StyleSheet element.
      • getDefaultLineStyle/setDefaultLineStyle : int 

        int getDefaultLineStyle() / setDefaultLineStyle(value)
        
        Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherits its line style from the specified StyleSheet element.
      • getDefaultFillStyle/setDefaultFillStyle : int 

        int getDefaultFillStyle() / setDefaultFillStyle(value)
        
        Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherits its fill style from the specified StyleSheet element.
      • getDefaultGuideStyle/setDefaultGuideStyle : int 

        int getDefaultGuideStyle() / setDefaultGuideStyle(value)
        
        Specifies the ID of a StyleSheet element. The next time the user creates a guide, the guide inherits its guide style from the specified StyleSheet element.
      • getGlueSettings/setGlueSettings : int 

        int getGlueSettings() / setGlueSettings(value)
        
        Specifies the objects that shapes glue to when glue is enabled in the document. The value of the property is GlueSettings integer constant.
      • getSnapSettings/setSnapSettings : int 

        int getSnapSettings() / setSnapSettings(value)
        
        Specifies the objects that shapes snap to when snap is active in the window. The value of the property is SnapSettings integer constant.
      • getSnapExtensions/setSnapExtensions : int 

        int getSnapExtensions() / setSnapExtensions(value)
        
        Specifies whether a specific snap extension setting is enabled or disabled for the active window. The value of the property is SnapExtensions integer constant.
      • getDynamicGridEnabled/setDynamicGridEnabled : int 

        int getDynamicGridEnabled() / setDynamicGridEnabled(value)
        
        Specifies whether the dynamic grid feature is enabled for a document or window. The value of the property is BOOL integer constant.
      • getProtectStyles/setProtectStyles : int 

        int getProtectStyles() / setProtectStyles(value)
        
        Specifies whether the user is prevented from creating or editing styles. However, regardless of this setting, the user can still apply styles. The value of the property is BOOL integer constant.
      • getProtectShapes/setProtectShapes : int 

        int getProtectShapes() / setProtectShapes(value)
        
        Specifies whether the user is prevented from selecting shapes that have their LockSelect element set to 1. The value of the property is BOOL integer constant.
      • getProtectMasters/setProtectMasters : int 

        int getProtectMasters() / setProtectMasters(value)
        
        Specifies whether the user is prevented from creating, editing, or deleting masters. Regardless of this setting, the user can still create instances of masters. The value of the property is BOOL integer constant.
      • getProtectBkgnds/setProtectBkgnds : int 

        int getProtectBkgnds() / setProtectBkgnds(value)
        
        Specifies whether the user is prevented from deleting or editing background pages. The value of the property is BOOL integer constant.
      • getCustomMenusFile/setCustomMenusFile : String 

        String getCustomMenusFile() / setCustomMenusFile(value)
        
        Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom menus and accelerators for a document.
      • getCustomToolbarsFile/setCustomToolbarsFile : String 

        String getCustomToolbarsFile() / setCustomToolbarsFile(value)
        
        Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom toolbars and status bars for a document.
      • getAttachedToolbars/setAttachedToolbars : byte[] 

        byte[] getAttachedToolbars() / setAttachedToolbars(value)
        
        A MIME (Multipurpose Internet Mail Extensions) encoded Microsoft Visio user interface (VSU) file representing custom toolbars.