asposediagram.api

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.

Property Getters/Setters Summary
methodgetAvenueSizeX()
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.
methodgetAvenueSizeY()
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.
methodgetAvoidPageBreaks()
Specifies how shapes are placed on the page when shapes are laid out when a user selects Lay Out Shapes (Shape menu).
methodgetBlockSizeX()
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.
methodgetBlockSizeY()
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.
methodgetCtrlAsInput()
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.
methodgetDel()
method
setDel(value)
           A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
methodgetDynamicsOff()
Specifies whether placeable shapes move and connectors reroute around other shapes and connectors on the drawing page.
methodgetEnableGrid()
Specifies whether Microsoft Visio lays out shapes based on an internal page grid when the user selects Lay Out Shapes (Shape menu).
methodgetLineAdjustFrom()
Specifies which dynamic connectors to space apart if they route on top of each other.
methodgetLineAdjustTo()
Specifies which dynamic connectors to line up on top of one another if they route on top of each other.
methodgetLineJumpCode()
Specifies the line jump style for all connectors on the drawing page that don't have a local line jump style.
methodgetLineJumpFactorX()
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.
methodgetLineJumpFactorY()
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.
methodgetLineJumpStyle()
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.
methodgetLineRouteExt()
Specifies the default appearance for all connectors on a page.
methodgetLineToLineX()
Specifies the minimum horizontal clearance between dynamic connectors on the drawing page.
methodgetLineToLineY()
Specifies the minimum vertical clearance between dynamic connectors on the drawing page.
methodgetLineToNodeX()
Specifies the minimum vertical clearance between dynamic connectors and shapes on the drawing page.
methodgetLineToNodeY()
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.
methodgetPageLineJumpDirX()
Specifies the direction of line jumps on vertical dynamic connectors on the drawing page for which you haven't applied a local jump direction.
methodgetPageLineJumpDirY()
Specifies the minimum horizontal clearance between dynamic connectors and shapes on the drawing page.
methodgetPageShapeSplit()
Indicates whether shapes on the page can be split automatically.
methodgetPlaceDepth()
Specifies whether placeable shapes move away when the user drags a placeable shape near another placeable shape on the drawing page.
methodgetPlaceFlip()
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.
methodgetPlaceStyle()
Specifies the routing style and direction for all dynamic connectors on the drawing page that don't have a local routing style.
methodgetPlowCode()
Determines the dynamic connectors to which you want to add jumps.
methodgetResizePage()
Specifies whether to enlarge the page to enclose the drawing after a user selects Lay Out Shapes (Shapes menu).
methodgetRouteStyle()
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.
 

    • Property Getters/Setters Detail

      • getDel/setDel : int 

        int getDel() / setDel(value)
        
        A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
      • getResizePage : BoolValue 

        BoolValue getResizePage()
        
        Specifies whether to enlarge the page to enclose the drawing after a user selects Lay Out Shapes (Shapes menu).
      • getEnableGrid : BoolValue 

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

        BoolValue getDynamicsOff()
        
        Specifies whether placeable shapes move and connectors reroute around other shapes and connectors on the drawing page.
      • getCtrlAsInput : BoolValue 

        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.
      • getAvoidPageBreaks : BoolValue 

        BoolValue getAvoidPageBreaks()
        
        Specifies how shapes are placed on the page when shapes are laid out when a user selects Lay Out Shapes (Shape menu).
      • getPlaceStyle : PlaceStyle 

        PlaceStyle getPlaceStyle()
        
        Specifies the routing style and direction for all dynamic connectors on the drawing page that don't have a local routing style.
      • getRouteStyle : RouteStyle 

        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.
      • getPlaceDepth : PlaceDepth 

        PlaceDepth getPlaceDepth()
        
        Specifies whether placeable shapes move away when the user drags a placeable shape near another placeable shape on the drawing page.
      • getPlowCode : BoolValue 

        BoolValue getPlowCode()
        
        Determines the dynamic connectors to which you want to add jumps.
      • getLineJumpCode : LineJumpCode 

        LineJumpCode getLineJumpCode()
        
        Specifies the line jump style for all connectors on the drawing page that don't have a local line jump style.
      • getLineJumpStyle : LineJumpStyle 

        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.
      • getPageLineJumpDirX : PageLineJumpDirX 

        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.
      • getPageLineJumpDirY : PageLineJumpDirY 

        PageLineJumpDirY getPageLineJumpDirY()
        
        Specifies the minimum horizontal clearance between dynamic connectors and shapes on the drawing page.
      • getLineToNodeX : DoubleValue 

        DoubleValue getLineToNodeX()
        
        Specifies the minimum vertical clearance between dynamic connectors and shapes on the drawing page.
      • getLineToNodeY : DoubleValue 

        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.
      • getBlockSizeX : DoubleValue 

        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.
      • getBlockSizeY : DoubleValue 

        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.
      • getAvenueSizeX : DoubleValue 

        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.
      • getAvenueSizeY : DoubleValue 

        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.
      • getLineToLineX : DoubleValue 

        DoubleValue getLineToLineX()
        
        Specifies the minimum horizontal clearance between dynamic connectors on the drawing page.
      • getLineToLineY : DoubleValue 

        DoubleValue getLineToLineY()
        
        Specifies the minimum vertical clearance between dynamic connectors on the drawing page.
      • getLineJumpFactorX : DoubleValue 

        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.
      • getLineJumpFactorY : DoubleValue 

        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.
      • getLineAdjustFrom : LineAdjustFrom 

        LineAdjustFrom getLineAdjustFrom()
        
        Specifies which dynamic connectors to space apart if they route on top of each other.
      • getLineAdjustTo : LineAdjustTo 

        LineAdjustTo getLineAdjustTo()
        
        Specifies which dynamic connectors to line up on top of one another if they route on top of each other.
      • getPlaceFlip : PlaceFlip 

        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.
      • getLineRouteExt : LineRouteExt 

        LineRouteExt getLineRouteExt()
        
        Specifies the default appearance for all connectors on a page.
      • getPageShapeSplit : BoolValue 

        BoolValue getPageShapeSplit()
        
        Indicates whether shapes on the page can be split automatically.