DocumentSettings

Inheritance: java.lang.Object

public class DocumentSettings

Contains elements that specify document settings.

Methods

MethodDescription
equals(Object arg0)
getAttachedToolbars()A MIME (Multipurpose Internet Mail Extensions) encoded Microsoft Visio user interface (VSU) file representing custom toolbars.
getClass()
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.
getDefaultGuideStyle()Specifies the ID of a StyleSheet element.
getDefaultLineStyle()Specifies the ID of a StyleSheet element.
getDefaultTextStyle()Specifies the ID of a StyleSheet element.
getDynamicGridEnabled()Specifies whether the dynamic grid feature is enabled for a document or window.
getGlueSettings()Specifies the objects that shapes glue to when glue is enabled in the document.
getProtectBkgnds()Specifies whether the user is prevented from deleting or editing background pages.
getProtectMasters()Specifies whether the user is prevented from creating, editing, or deleting masters.
getProtectShapes()Specifies whether the user is prevented from selecting shapes that have their LockSelect element set to 1.
getProtectStyles()Specifies whether the user is prevented from creating or editing styles.
getSnapAngles()Contains a collection of SnapAngle elements.
getSnapExtensions()Specifies whether a specific snap extension setting is enabled or disabled for the active window.
getSnapSettings()Specifies the objects that shapes snap to when snap is active in the window.
getTopPage()Specifies the ID of the page that should be displayed when the document is opened by Microsoft Visio.
hashCode()
notify()
notifyAll()
setAttachedToolbars(byte[] value)For the description of this property, please see getAttachedToolbars()
setCustomMenusFile(String value)For the description of this property, please see getCustomMenusFile()
setCustomToolbarsFile(String value)For the description of this property, please see getCustomToolbarsFile()
setDefaultFillStyle(int value)For the description of this property, please see getDefaultFillStyle()
setDefaultGuideStyle(int value)For the description of this property, please see getDefaultGuideStyle()
setDefaultLineStyle(int value)For the description of this property, please see getDefaultLineStyle()
setDefaultTextStyle(int value)For the description of this property, please see getDefaultTextStyle()
setDynamicGridEnabled(int value)For the description of this property, please see getDynamicGridEnabled()
setGlueSettings(int value)For the description of this property, please see getGlueSettings()
setProtectBkgnds(int value)For the description of this property, please see getProtectBkgnds()
setProtectMasters(int value)For the description of this property, please see getProtectMasters()
setProtectShapes(int value)For the description of this property, please see getProtectShapes()
setProtectStyles(int value)For the description of this property, please see getProtectStyles()
setSnapAngles(FloatPointNumCollection value)For the description of this property, please see getSnapAngles()
setSnapExtensions(int value)For the description of this property, please see getSnapExtensions()
setSnapSettings(int value)For the description of this property, please see getSnapSettings()
setTopPage(int value)For the description of this property, please see getTopPage()
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getAttachedToolbars()

public byte[] getAttachedToolbars()

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

Returns: byte[]

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCustomMenusFile()

public String getCustomMenusFile()

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

Returns: java.lang.String

getCustomToolbarsFile()

public String getCustomToolbarsFile()

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

Returns: java.lang.String

getDefaultFillStyle()

public int 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.

Returns: int

getDefaultGuideStyle()

public int 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.

Returns: int

getDefaultLineStyle()

public int 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.

Returns: int

getDefaultTextStyle()

public int 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.

Returns: int

getDynamicGridEnabled()

public int getDynamicGridEnabled()

Specifies whether the dynamic grid feature is enabled for a document or window.

Returns: int

getGlueSettings()

public int getGlueSettings()

Specifies the objects that shapes glue to when glue is enabled in the document.

Returns: int

getProtectBkgnds()

public int getProtectBkgnds()

Specifies whether the user is prevented from deleting or editing background pages.

Returns: int

getProtectMasters()

public int 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.

Returns: int

getProtectShapes()

public int getProtectShapes()

Specifies whether the user is prevented from selecting shapes that have their LockSelect element set to 1.

Returns: int

getProtectStyles()

public int getProtectStyles()

Specifies whether the user is prevented from creating or editing styles. However, regardless of this setting, the user can still apply styles.

Returns: int

getSnapAngles()

public FloatPointNumCollection getSnapAngles()

Contains a collection of SnapAngle elements.

Returns: FloatPointNumCollection

getSnapExtensions()

public int getSnapExtensions()

Specifies whether a specific snap extension setting is enabled or disabled for the active window.

Returns: int

getSnapSettings()

public int getSnapSettings()

Specifies the objects that shapes snap to when snap is active in the window.

Returns: int

getTopPage()

public int getTopPage()

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

Returns: int

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAttachedToolbars(byte[] value)

public void setAttachedToolbars(byte[] value)

For the description of this property, please see getAttachedToolbars()

Parameters:

ParameterTypeDescription
valuebyte[]

setCustomMenusFile(String value)

public void setCustomMenusFile(String value)

For the description of this property, please see getCustomMenusFile()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setCustomToolbarsFile(String value)

public void setCustomToolbarsFile(String value)

For the description of this property, please see getCustomToolbarsFile()

Parameters:

ParameterTypeDescription
valuejava.lang.String

setDefaultFillStyle(int value)

public void setDefaultFillStyle(int value)

For the description of this property, please see getDefaultFillStyle()

Parameters:

ParameterTypeDescription
valueint

setDefaultGuideStyle(int value)

public void setDefaultGuideStyle(int value)

For the description of this property, please see getDefaultGuideStyle()

Parameters:

ParameterTypeDescription
valueint

setDefaultLineStyle(int value)

public void setDefaultLineStyle(int value)

For the description of this property, please see getDefaultLineStyle()

Parameters:

ParameterTypeDescription
valueint

setDefaultTextStyle(int value)

public void setDefaultTextStyle(int value)

For the description of this property, please see getDefaultTextStyle()

Parameters:

ParameterTypeDescription
valueint

setDynamicGridEnabled(int value)

public void setDynamicGridEnabled(int value)

For the description of this property, please see getDynamicGridEnabled()

Parameters:

ParameterTypeDescription
valueint

setGlueSettings(int value)

public void setGlueSettings(int value)

For the description of this property, please see getGlueSettings()

Parameters:

ParameterTypeDescription
valueint

setProtectBkgnds(int value)

public void setProtectBkgnds(int value)

For the description of this property, please see getProtectBkgnds()

Parameters:

ParameterTypeDescription
valueint

setProtectMasters(int value)

public void setProtectMasters(int value)

For the description of this property, please see getProtectMasters()

Parameters:

ParameterTypeDescription
valueint

setProtectShapes(int value)

public void setProtectShapes(int value)

For the description of this property, please see getProtectShapes()

Parameters:

ParameterTypeDescription
valueint

setProtectStyles(int value)

public void setProtectStyles(int value)

For the description of this property, please see getProtectStyles()

Parameters:

ParameterTypeDescription
valueint

setSnapAngles(FloatPointNumCollection value)

public void setSnapAngles(FloatPointNumCollection value)

For the description of this property, please see getSnapAngles()

Parameters:

ParameterTypeDescription
valueFloatPointNumCollection

setSnapExtensions(int value)

public void setSnapExtensions(int value)

For the description of this property, please see getSnapExtensions()

Parameters:

ParameterTypeDescription
valueint

setSnapSettings(int value)

public void setSnapSettings(int value)

For the description of this property, please see getSnapSettings()

Parameters:

ParameterTypeDescription
valueint

setTopPage(int value)

public void setTopPage(int value)

For the description of this property, please see getTopPage()

Parameters:

ParameterTypeDescription
valueint

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int