PageLayout

Inheritance: java.lang.Object

public class PageLayout

Contains cells that control the page layout settings for shapes and connectors, such as spacing between all shapes on the page, spacing between all connectors on the page, and routing style for all connectors on the page.

Methods

MethodDescription
equals(Object arg0)
getAvenueSizeX()Determines the amount of vertical space between shapes on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.
getAvenueSizeY()Determines the amount of vertical space between shapes on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.
getAvoidPageBreaks()Specifies how shapes are placed on the page when shapes are laid out when a user selects Lay Out Shapes (Shape menu).
getBlockSizeX()Determines the vertical block size, the area in which each of your shapes must fit on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.
getBlockSizeY()Determines the amount of horizontal space between shapes on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.
getClass()
getCtrlAsInput()Determines which shape is the parent when using shapes by control handles.
getDel()A flag indicating whether the element has been deleted locally.
getDynamicsOff()Specifies whether placeable shapes move and connectors reroute around other shapes and connectors on the drawing page.
getEnableGrid()Specifies whether Microsoft Visio lays out shapes based on an internal page grid when the user selects Lay Out Shapes (Shape menu).
getLineAdjustFrom()Specifies which dynamic connectors to space apart if they route on top of each other.
getLineAdjustTo()Specifies which dynamic connectors to line up on top of one another if they route on top of each other.
getLineJumpCode()Specifies the line jump style for all connectors on the drawing page that don’t have a local line jump style.
getLineJumpFactorX()Specifies the size of line jumps on horizontal segments of dynamic connectors on the page, as a percentage of the value of the LineToLineX element (which specifies the horizontal clearance between all connectors on the drawing page).
getLineJumpFactorY()Specifies the size of line jumps on vertical segments of dynamic connectors on the page, as a percentage of the value of the LineToLineY element (which specifies the vertical clearance between all connectors on the drawing page).
getLineJumpStyle()Specifies the direction of line jumps on horizontal segments of dynamic connectors on the drawing page for which you haven’t applied a local jump direction.
getLineRouteExt()Specifies the default appearance for all connectors on a page.
getLineToLineX()Specifies the minimum horizontal clearance between dynamic connectors on the drawing page.
getLineToLineY()Specifies the minimum vertical clearance between dynamic connectors on the drawing page.
getLineToNodeX()Specifies the minimum vertical clearance between dynamic connectors and shapes on the drawing page.
getLineToNodeY()Determines the horizontal block size, the area in which each of your shapes must fit on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.
getPageLineJumpDirX()Specifies the direction of line jumps on vertical dynamic connectors on the drawing page for which you haven’t applied a local jump direction.
getPageLineJumpDirY()Specifies the minimum horizontal clearance between dynamic connectors and shapes on the drawing page.
getPageShapeSplit()Indicates whether shapes on the page can be split automatically.
getPlaceDepth()Specifies whether placeable shapes move away when the user drags a placeable shape near another placeable shape on the drawing page.
getPlaceFlip()Specifies how placeable shapes flip and/or rotate on a page when shapes are laid out using the Lay Out Shapes command in Microsoft Visio.
getPlaceStyle()Specifies the routing style and direction for all dynamic connectors on the drawing page that don’t have a local routing style.
getPlowCode()Determines the dynamic connectors to which you want to add jumps.
getResizePage()Specifies whether to enlarge the page to enclose the drawing after a user selects Lay Out Shapes (Shapes menu).
getRouteStyle()For a drawing that is laid out automatically, specifies the method by which the drawing is analyzed before creating the layout and determines the type of layout.
hashCode()
notify()
notifyAll()
setDel(int value)For the description of this property, please see getDel()
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

getAvenueSizeX()

public DoubleValue getAvenueSizeX()

Determines the amount of vertical space between shapes on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.

Returns: DoubleValue

getAvenueSizeY()

public DoubleValue getAvenueSizeY()

Determines the amount of vertical space between shapes on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.

Returns: DoubleValue

getAvoidPageBreaks()

public BoolValue getAvoidPageBreaks()

Specifies how shapes are placed on the page when shapes are laid out when a user selects Lay Out Shapes (Shape menu).

Returns: BoolValue

getBlockSizeX()

public DoubleValue getBlockSizeX()

Determines the vertical block size, the area in which each of your shapes must fit on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.

Returns: DoubleValue

getBlockSizeY()

public DoubleValue getBlockSizeY()

Determines the amount of horizontal space between shapes on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.

Returns: DoubleValue

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCtrlAsInput()

public BoolValue getCtrlAsInput()

Determines which shape is the parent when using shapes by control handles. This element sets the behavior for all the shapes on the drawing page.

Returns: BoolValue

getDel()

public int getDel()

A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally.

Returns: int

getDynamicsOff()

public BoolValue getDynamicsOff()

Specifies whether placeable shapes move and connectors reroute around other shapes and connectors on the drawing page.

Returns: BoolValue

getEnableGrid()

public BoolValue getEnableGrid()

Specifies whether Microsoft Visio lays out shapes based on an internal page grid when the user selects Lay Out Shapes (Shape menu).

Returns: BoolValue

getLineAdjustFrom()

public LineAdjustFrom getLineAdjustFrom()

Specifies which dynamic connectors to space apart if they route on top of each other.

Returns: LineAdjustFrom

getLineAdjustTo()

public LineAdjustTo getLineAdjustTo()

Specifies which dynamic connectors to line up on top of one another if they route on top of each other.

Returns: LineAdjustTo

getLineJumpCode()

public LineJumpCode getLineJumpCode()

Specifies the line jump style for all connectors on the drawing page that don’t have a local line jump style.

Returns: LineJumpCode

getLineJumpFactorX()

public DoubleValue getLineJumpFactorX()

Specifies the size of line jumps on horizontal segments of dynamic connectors on the page, as a percentage of the value of the LineToLineX element (which specifies the horizontal clearance between all connectors on the drawing page). The value of this element ranges from 0 to 10.

Returns: DoubleValue

getLineJumpFactorY()

public DoubleValue getLineJumpFactorY()

Specifies the size of line jumps on vertical segments of dynamic connectors on the page, as a percentage of the value of the LineToLineY element (which specifies the vertical clearance between all connectors on the drawing page). This element can contain a value from 0 to 10.

Returns: DoubleValue

getLineJumpStyle()

public LineJumpStyle getLineJumpStyle()

Specifies the direction of line jumps on horizontal segments of dynamic connectors on the drawing page for which you haven’t applied a local jump direction.

Returns: LineJumpStyle

getLineRouteExt()

public LineRouteExt getLineRouteExt()

Specifies the default appearance for all connectors on a page.

Returns: LineRouteExt

getLineToLineX()

public DoubleValue getLineToLineX()

Specifies the minimum horizontal clearance between dynamic connectors on the drawing page.

Returns: DoubleValue

getLineToLineY()

public DoubleValue getLineToLineY()

Specifies the minimum vertical clearance between dynamic connectors on the drawing page.

Returns: DoubleValue

getLineToNodeX()

public DoubleValue getLineToNodeX()

Specifies the minimum vertical clearance between dynamic connectors and shapes on the drawing page.

Returns: DoubleValue

getLineToNodeY()

public DoubleValue getLineToNodeY()

Determines the horizontal block size, the area in which each of your shapes must fit on the drawing page when you use Microsoft Visio to lay out shapes on the drawing page.

Returns: DoubleValue

getPageLineJumpDirX()

public PageLineJumpDirX getPageLineJumpDirX()

Specifies the direction of line jumps on vertical dynamic connectors on the drawing page for which you haven’t applied a local jump direction.

Returns: PageLineJumpDirX

getPageLineJumpDirY()

public PageLineJumpDirY getPageLineJumpDirY()

Specifies the minimum horizontal clearance between dynamic connectors and shapes on the drawing page.

Returns: PageLineJumpDirY

getPageShapeSplit()

public BoolValue getPageShapeSplit()

Indicates whether shapes on the page can be split automatically.

Returns: BoolValue

getPlaceDepth()

public PlaceDepth getPlaceDepth()

Specifies whether placeable shapes move away when the user drags a placeable shape near another placeable shape on the drawing page.

Returns: PlaceDepth

getPlaceFlip()

public PlaceFlip getPlaceFlip()

Specifies how placeable shapes flip and/or rotate on a page when shapes are laid out using the Lay Out Shapes command in Microsoft Visio. The following hexadecimal values are allowed.

Returns: PlaceFlip

getPlaceStyle()

public PlaceStyle getPlaceStyle()

Specifies the routing style and direction for all dynamic connectors on the drawing page that don’t have a local routing style.

Returns: PlaceStyle

getPlowCode()

public BoolValue getPlowCode()

Determines the dynamic connectors to which you want to add jumps.

Returns: BoolValue

getResizePage()

public BoolValue getResizePage()

Specifies whether to enlarge the page to enclose the drawing after a user selects Lay Out Shapes (Shapes menu).

Returns: BoolValue

getRouteStyle()

public RouteStyle getRouteStyle()

For a drawing that is laid out automatically, specifies the method by which the drawing is analyzed before creating the layout and determines the type of layout.

Returns: RouteStyle

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setDel(int value)

public void setDel(int value)

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

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