PageProps

PageProps class

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

Properties

NameTypeDescription
DelintA flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted loca
PageWidthDoubleValueSpecifies the width of the page in drawing units.
PageHeightDoubleValueSpecifies the height of the page in drawing units.
ShdwOffsetXDoubleValueSpecifies the distance in page units that a shape’s drop shadow is offset horizontally from the shape.
ShdwOffsetYDoubleValueSpecifies the distance in page units that a shape’s drop shadow is offset vertically from the shape.
PageScaleDoubleValueSpecifies the value of the default page unit in the current drawing scale. The drawing scale for the page is the ratio o
DrawingScaleDoubleValueRepresents the value of the drawing unit in the current drawing scale. The drawing scale for the page is the ratio of th
DrawingSizeTypeDrawingSizeTypeSpecifies the drawing size of a page.
DrawingScaleTypeDrawingScaleTypeSpecifies the type of drawing scale to use for a page.
InhibitSnapBoolValueSpecifies whether the shapes on a foreground page snap to other objects on the page and shapes on the background page.
UIVisibilityUIVisibilityDetermines whether the page name is exposed in the user interface (UI). A value of one specifies that the page is not vi
ShdwTypeShdwTypeIndicates the default shadow type for a page.
ShdwObliqueAngleDoubleValueContains a number that specifies the angle of oblique direction when the default page shadow type is applied.
ShdwScaleFactorDoubleValueSpecifies the percentage to enlarge or reduce a shape’s shadow.
DrawingResizeTypeDrawingResizeTypeDetermines whether the drawing page resizes automatically to fit the diagram.

Methods

NameDescription
deepCloneCreates deep copy of this instance.

PageProps.Del property

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.

Type: int

PageProps.PageWidth property

Specifies the width of the page in drawing units.

Type: DoubleValue

PageProps.PageHeight property

Specifies the height of the page in drawing units.

Type: DoubleValue

PageProps.ShdwOffsetX property

Specifies the distance in page units that a shape’s drop shadow is offset horizontally from the shape.

Type: DoubleValue

PageProps.ShdwOffsetY property

Specifies the distance in page units that a shape’s drop shadow is offset vertically from the shape.

Type: DoubleValue

PageProps.PageScale property

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.

Type: DoubleValue

PageProps.DrawingScale property

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.

Type: DoubleValue

PageProps.DrawingSizeType property

Specifies the drawing size of a page.

Type: DrawingSizeType

PageProps.DrawingScaleType property

Specifies the type of drawing scale to use for a page.

Type: DrawingScaleType

PageProps.InhibitSnap property

Specifies whether the shapes on a foreground page snap to other objects on the page and shapes on the background page.

Type: BoolValue

PageProps.UIVisibility property

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

Type: UIVisibility

PageProps.ShdwType property

Indicates the default shadow type for a page.

Type: ShdwType

PageProps.ShdwObliqueAngle property

Contains a number that specifies the angle of oblique direction when the default page shadow type is applied.

Type: DoubleValue

PageProps.ShdwScaleFactor property

Specifies the percentage to enlarge or reduce a shape’s shadow.

Type: DoubleValue

PageProps.DrawingResizeType property

Determines whether the drawing page resizes automatically to fit the diagram.

Type: DrawingResizeType

deepClone()

Creates deep copy of this instance.