DocumentSettings

DocumentSettings class

Contains elements that specify document settings.

Methods

NameDescription
getAttachedToolbars()A MIME (Multipurpose Internet Mail Extensions) encoded Microsoft Visio user interface (VSU) file representing custom too
getCustomMenusFile()Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom menus and accelerators for a doc
getCustomToolbarsFile()Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom toolbars and status bars for a d
getDefaultFillStyle()Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherit
getDefaultGuideStyle()Specifies the ID of a StyleSheet element. The next time the user creates a guide, the guide inherits its guide style fro
getDefaultLineStyle()Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherit
getDefaultTextStyle()Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherit
getDynamicGridEnabled()Specifies whether the dynamic grid feature is enabled for a document or window. The value of the property is BOOL intege
getGlueSettings()Specifies the objects that shapes glue to when glue is enabled in the document. The value of the property is GlueSetting
getProtectBkgnds()Specifies whether the user is prevented from deleting or editing background pages. The value of the property is BOOL int
getProtectMasters()Specifies whether the user is prevented from creating, editing, or deleting masters. Regardless of this setting, the use
getProtectShapes()Specifies whether the user is prevented from selecting shapes that have their LockSelect element set to 1. The value of
getProtectStyles()Specifies whether the user is prevented from creating or editing styles. However, regardless of this setting, the user c
getSnapAngles()Contains a collection of SnapAngle elements.
getSnapExtensions()Specifies whether a specific snap extension setting is enabled or disabled for the active window. The value of the prope
getSnapSettings()Specifies the objects that shapes snap to when snap is active in the window. The value of the property is SnapSettings i
getTopPage()Specifies the ID of the page that should be displayed when the document is opened by Microsoft Visio.
setAttachedToolbars()A MIME (Multipurpose Internet Mail Extensions) encoded Microsoft Visio user interface (VSU) file representing custom too
setCustomMenusFile()Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom menus and accelerators for a doc
setCustomToolbarsFile()Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom toolbars and status bars for a d
setDefaultFillStyle()Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherit
setDefaultGuideStyle()Specifies the ID of a StyleSheet element. The next time the user creates a guide, the guide inherits its guide style fro
setDefaultLineStyle()Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherit
setDefaultTextStyle()Specifies the ID of a StyleSheet element. The next time the user creates a shape using a drawing tool, the shape inherit
setDynamicGridEnabled()Specifies whether the dynamic grid feature is enabled for a document or window. The value of the property is BOOL intege
setGlueSettings()Specifies the objects that shapes glue to when glue is enabled in the document. The value of the property is GlueSetting
setProtectBkgnds()Specifies whether the user is prevented from deleting or editing background pages. The value of the property is BOOL int
setProtectMasters()Specifies whether the user is prevented from creating, editing, or deleting masters. Regardless of this setting, the use
setProtectShapes()Specifies whether the user is prevented from selecting shapes that have their LockSelect element set to 1. The value of
setProtectStyles()Specifies whether the user is prevented from creating or editing styles. However, regardless of this setting, the user c
setSnapAngles()Contains a collection of SnapAngle elements.
setSnapExtensions()Specifies whether a specific snap extension setting is enabled or disabled for the active window. The value of the prope
setSnapSettings()Specifies the objects that shapes snap to when snap is active in the window. The value of the property is SnapSettings i
setTopPage()Specifies the ID of the page that should be displayed when the document is opened by Microsoft Visio.

getAttachedToolbars()

A MIME (Multipurpose Internet Mail Extensions) encoded Microsoft Visio user interface (VSU) file representing custom toolbars.

getCustomMenusFile()

Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom menus and accelerators for a document.

getCustomToolbarsFile()

Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom toolbars and status bars for a document.

getDefaultFillStyle()

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()

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.

getDefaultLineStyle()

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.

getDefaultTextStyle()

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.

getDynamicGridEnabled()

Specifies whether the dynamic grid feature is enabled for a document or window. The value of the property is BOOL integer constant.

getGlueSettings()

Specifies the objects that shapes glue to when glue is enabled in the document. The value of the property is GlueSettings integer constant.

getProtectBkgnds()

Specifies whether the user is prevented from deleting or editing background pages. The value of the property is BOOL integer constant.

getProtectMasters()

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.

getProtectShapes()

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.

getProtectStyles()

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.

getSnapAngles()

Contains a collection of SnapAngle elements.

getSnapExtensions()

Specifies whether a specific snap extension setting is enabled or disabled for the active window. The value of the property is SnapExtensions integer constant.

getSnapSettings()

Specifies the objects that shapes snap to when snap is active in the window. The value of the property is SnapSettings integer constant.

getTopPage()

Specifies the ID of the page that should be displayed when the document is opened by Microsoft Visio.

setAttachedToolbars()

A MIME (Multipurpose Internet Mail Extensions) encoded Microsoft Visio user interface (VSU) file representing custom toolbars.

setCustomMenusFile()

Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom menus and accelerators for a document.

setCustomToolbarsFile()

Contains the name of the Microsoft Visio user interface (.vsu) file that defines custom toolbars and status bars for a document.

setDefaultFillStyle()

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.

setDefaultGuideStyle()

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.

setDefaultLineStyle()

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.

setDefaultTextStyle()

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.

setDynamicGridEnabled()

Specifies whether the dynamic grid feature is enabled for a document or window. The value of the property is BOOL integer constant.

setGlueSettings()

Specifies the objects that shapes glue to when glue is enabled in the document. The value of the property is GlueSettings integer constant.

setProtectBkgnds()

Specifies whether the user is prevented from deleting or editing background pages. The value of the property is BOOL integer constant.

setProtectMasters()

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.

setProtectShapes()

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.

setProtectStyles()

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.

setSnapAngles()

Contains a collection of SnapAngle elements.

setSnapExtensions()

Specifies whether a specific snap extension setting is enabled or disabled for the active window. The value of the property is SnapExtensions integer constant.

setSnapSettings()

Specifies the objects that shapes snap to when snap is active in the window. The value of the property is SnapSettings integer constant.

setTopPage()

Specifies the ID of the page that should be displayed when the document is opened by Microsoft Visio.