asposediagram.api

Class PageProps

Contains cells that control page attributes, such as the page width, height, and scale.

Property Getters/Setters Summary
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.
methodgetDrawingResizeType()
Determines whether the drawing page resizes automatically to fit the diagram.
methodgetDrawingScale()
Represents the value of the drawing unit in the current drawing scale. The drawing scale for the page is the ratio of the page unit contained in the PageScale element to the drawing unit. The units of this element determine default length (DL) units for the page.
methodgetDrawingScaleType()
Specifies the type of drawing scale to use for a page.
methodgetDrawingSizeType()
Specifies the drawing size of a page.
methodgetInhibitSnap()
Specifies whether the shapes on a foreground page snap to other objects on the page and shapes on the background page.
methodgetPageHeight()
Specifies the height of the page in drawing units.
methodgetPageScale()
Specifies the value of the default page unit in the current drawing scale. The drawing scale for the page is the ratio of the page unit in the PageScale element to the drawing unit shown in the DrawingScale element.
methodgetPageWidth()
Specifies the width of the page in drawing units.
methodgetShdwObliqueAngle()
Contains a number that specifies the angle of oblique direction when the default page shadow type is applied.
methodgetShdwOffsetX()
Specifies the distance in page units that a shape's drop shadow is offset horizontally from the shape.
methodgetShdwOffsetY()
Specifies the distance in page units that a shape's drop shadow is offset vertically from the shape.
methodgetShdwScaleFactor()
Specifies the percentage to enlarge or reduce a shape's shadow.
methodgetShdwType()
Indicates the default shadow type for a page.
methodgetUIVisibility()
Determines whether the page name is exposed in the user interface (UI). A value of one specifies that the page is not visible; a value of zero specifies the page is visible
 
Method Summary
methoddeepClone()
Creates deep copy of this instance.
 

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

        DoubleValue getPageHeight()
        
        Specifies the height of the page in drawing units.
      • getShdwOffsetX : DoubleValue 

        DoubleValue getShdwOffsetX()
        
        Specifies the distance in page units that a shape's drop shadow is offset horizontally from the shape.
      • getShdwOffsetY : DoubleValue 

        DoubleValue getShdwOffsetY()
        
        Specifies the distance in page units that a shape's drop shadow is offset vertically from the shape.
      • getPageScale : DoubleValue 

        DoubleValue getPageScale()
        
        Specifies the value of the default page unit in the current drawing scale. The drawing scale for the page is the ratio of the page unit in the PageScale element to the drawing unit shown in the DrawingScale element.
      • getDrawingScale : DoubleValue 

        DoubleValue getDrawingScale()
        
        Represents the value of the drawing unit in the current drawing scale. The drawing scale for the page is the ratio of the page unit contained in the PageScale element to the drawing unit. The units of this element determine default length (DL) units for the page.
      • getInhibitSnap : BoolValue 

        BoolValue getInhibitSnap()
        
        Specifies whether the shapes on a foreground page snap to other objects on the page and shapes on the background page.
      • getUIVisibility : UIVisibility 

        UIVisibility getUIVisibility()
        
        Determines whether the page name is exposed in the user interface (UI). A value of one specifies that the page is not visible; a value of zero specifies the page is visible
      • getShdwType : ShdwType 

        ShdwType getShdwType()
        
        Indicates the default shadow type for a page.
      • getShdwObliqueAngle : DoubleValue 

        DoubleValue getShdwObliqueAngle()
        
        Contains a number that specifies the angle of oblique direction when the default page shadow type is applied.
      • getShdwScaleFactor : DoubleValue 

        DoubleValue getShdwScaleFactor()
        
        Specifies the percentage to enlarge or reduce a shape's shadow.
    • Method Detail

      • deepClone

        Object deepClone()
        Creates deep copy of this instance.
        Returns: