All Frameworks  Object Hierarchy  This Framework  Indexes

PageSetup (Object)

Represents the page setup.
The page setup is the object that stores data which defines how your documents and images are actually printed on paper. This data includes namely the paper size, the orientation, the bottom, top, right, and left margins, the zoom factor, the banner, and the printing quality.

Property Index

BannerPosition
Returns or sets the banner position.
BannerSize
Returns or sets Banner Size.
Banner
Returns or sets the banner text.
BottomMargin
Returns or sets the bottom margin.
Bottom
Returns or sets the lower left corner location with respect to the bottom of the sheet of paper.
Color
Returns or sets the color mode to use when printing.
Dpi
Returns or sets the printing dpi.
Gamma
Returns or sets Gamma factor for print.
LeftMargin
Returns or sets the left margin.
Left
Returns or sets the lower left corner location with respect to the left of the sheet of paper.
LineCap
Returns or sets Line cap for print.
LineTypeOverlappingCheck
Returns or sets text Line type overlap check option for print.
LineTypeSpecification
Returns or sets Line type specification for print.
LineWidthSpecification
Returns or sets Line width specification for print.
LogoVisibility
Returns or sets LogoVisibility option for print.
Logo
Returns or sets the file containing the logo image.
MaximumSize
Returns or sets whether the document or the image should be printed at the maximum size with respect to the page size and margins.
Orientation
Returns or sets the paper orientation.
PaperHeight
Returns or sets the paper height.
PaperSize
Returns or sets the paper size.
PaperWidth
Returns or sets the paper width.
PrintRenderingMode
Returns or sets the printing rendering mode.
Quality
Returns or sets the printing quality.
RightMargin
Returns or sets the right margin.
Rotation
Returns or sets the rotation of the document or the image to print.
Scaling1To1
Returns or sets whether the document or the image should be printed with a zoom factor equals to 1 and the image to print lower left corner on the paper lower corner.
TextBlanking
Returns or sets the text blanking option in print Text will be printed in blanking rectangle Default value is FALSE
Example:
This example sets the text blanking option for the SetupForMyPrint page setup.
TextScaling
Returns or sets text scaling option for print.
TopMargin
Returns or sets the top margin.
Use3DAccuracy
Returns or sets Use3DAccuracy option for print.
UseImageSize
Returns or sets the paper size to the image size.
WhiteVectorsInBlack
Returns or sets the white vectors in black option.
Zoom
Returns or sets the zoom factor to use when printing.

Properties


o Property BannerPosition() As
Returns or sets the banner position. The banner can be located on the top, bottom, left, or right side of the page. catBannerPositionNone removes the banner.
Example:
This example sets the banner on the top side of the page for the SetupForMyPrint page setup. 
 SetupForMyPrint.BannerPosition = CatBannerPositionTop
o Property BannerSize() As
Returns or sets Banner Size. Banner size could range from 0.1 mm to 10.0 mm Default value is 2.4 mm
Example:
This example sets banner size for the SetupForMyPrint page setup. 
 SetupForMyPrint.BannerSize = 1.1
o Property Banner() As
Returns or sets the banner text. The banner text is added to the print and can include variables, such as the user who prints, the date and time of printing. Available variables are:
$USER
The user name
$HOST
The workstation name
$SCALE
The print scale
$TIME
The print time
$DATE
The print date
$DAY
The print day
$MONTH
The print month
$YEAR
The print year

The default banner is: 

 Printed by $USER on $DATE $TIME
Example:
This example sets the banner text to the following:
Printed by $USER at scale $SCALE on $MONTH/$DAY/$YEAR
for the SetupForMyPrint page setup. 
 SetupForMyPrint.Banner = "Printed by $USER at scale $SCALE on $MONTH/$DAY/$YEAR"
o Property BottomMargin() As
Returns or sets the bottom margin. The bottom margin is a strip in which nothing is printed, located at the bottom of the page, which height is expressed in mm.
Example:
This example sets the bottom margin for the SetupForMyPrint page setup to 10 mm. 
 SetupForMyPrint.BottomMargin = 10
o Property Bottom() As
Returns or sets the lower left corner location with respect to the bottom of the sheet of paper. This is the distance of the document or the image to print lower left corner to the paper lower left corner.
Example:
This example sets the location of the lower left corner of the document or the image to print at 40 mm from the paper lower left corner for the SetupForMyPrint page setup. 
 SetupForMyPrint.Bottom = 40
o Property Color() As
Returns or sets the color mode to use when printing.
Example:
This example sets the color mode to GreyScale for the SetupForMyPrint page setup. 
 SetupForMyPrint.Color = catColorGreyScale
o Property Dpi() As
Returns or sets the printing dpi.
Example:
This example sets the printing dpi for the SetupForMyPrint page setup. 
 SetupForMyPrint.Dpi = 150.
o Property Gamma() As
Returns or sets Gamma factor for print. Gamma value could range from 0.1 to 5.0 Default value is 1.0
Example:
This example sets Gamma factor for the SetupForMyPrint page setup. 
 SetupForMyPrint.Gamma = 1.2
o Property LeftMargin() As
Returns or sets the left margin. The left margin is a strip in which nothing is printed, located at the left of the page, which width is expressed in mm.
Example:
This example sets the left margin for the SetupForMyPrint page setup to 10 mm. 
 SetupForMyPrint.LeftMargin = 10
o Property Left() As
Returns or sets the lower left corner location with respect to the left of the sheet of paper. This is the distance of the document or the image to print lower left corner to the paper lower left corner.
Example:
This example sets the location of the lower left corner of the document or the image to print at 25 mm from the paper lower left corner for the SetupForMyPrint page setup. 
 SetupForMyPrint.Left = 25
o Property LineCap() As
Returns or sets Line cap for print. Refer to CatPrintLineCap Default value is catPrintFlat
Example:
This example sets Line cap for the SetupForMyPrint page setup. 
 SetupForMyPrint.LineCap = catPrintFlat
o Property LineTypeOverlappingCheck() As
Returns or sets text Line type overlap check option for print. Default value is FALSE
Example:
This example sets Line type overlapping check option for the SetupForMyPrint page setup. 
 SetupForMyPrint.LineTypeOverlappingCheck = True
o Property LineTypeSpecification() As
Returns or sets Line type specification for print. Refer to CatPrintLineSpecification Default value is catPrintAbsolute
Example:
This example sets Line type specification for the SetupForMyPrint page setup. 
 SetupForMyPrint.LineTypeSpecification = catPrintAbsolute
o Property LineWidthSpecification() As
Returns or sets Line width specification for print. Refer to CatPrintLineSpecification Default value is catPrintAbsolute
Example:
This example sets Line width specification for the SetupForMyPrint page setup. 
 SetupForMyPrint.LineWidthSpecification = catPrintAbsolute
o Property LogoVisibility() As
Returns or sets LogoVisibility option for print. Default value is FALSE
Example:
This example sets LogoVisibility option for the SetupForMyPrint page setup. 
 SetupForMyPrint.LogoVisibility = True
o Property Logo() As
Returns or sets the file containing the logo image. The logo is printed with the banner.
Example:
This example sets the logo file to the following file: e:\users\psr\Images\Logo.tif for the SetupForMyPrint page setup. 
 SetupForMyPrint.Logo = "e:\users\psr\Images\Logo.tif"
o Property MaximumSize() As
Returns or sets whether the document or the image should be printed at the maximum size with respect to the page size and margins.
True if the document or the image is printed with the maximum size. This overrides the location properties, that is Left and Bottom, and the Zoom property values.
Example:
This example requests to print the document or the image with the SetupForMyPrint page setup at maximum size. 
 SetupForMyPrint.MaximumSize = True
o Property Orientation() As
Returns or sets the paper orientation.
Example:
This example sets the paper orientation for the SetupForMyPrint page setup to catPaperLandscape. 
 SetupForMyPrint.Orientation = catPaperLandscape
o Property PaperHeight() As
Returns or sets the paper height.
Example:
This example sets the page height for the SetupForMyPrint page setup to 297 mm.. 
 SetupForMyPrint.PaperHeight = 297
o Property PaperSize() As
Returns or sets the paper size.
Example:
This example sets the page size for the SetupForMyPrint page setup to catPaperA4. 
 SetupForMyPrint.PaperSize = catPaperA4
o Property PaperWidth() As
Returns or sets the paper width.
Example:
This example sets the page width for the SetupForMyPrint page setup to 210 mm.. 
 SetupForMyPrint.PaperWidth = 210
o Property PrintRenderingMode() As
Returns or sets the printing rendering mode.
Example:
This example sets the printing rendering mode for the SetupForMyPrint page setup. 
 SetupForMyPrint.PrintRenderingMode = CatPrintRenderingModeDefault
o Property Quality() As
Returns or sets the printing quality. Refer to CatPrintQuality
Example:
This example sets the printing quality to draft for the SetupForMyPrint page setup. 
 SetupForMyPrint.Quality = catPrintQualityDraft
o Property RightMargin() As
Returns or sets the right margin. The right margin is a strip in which nothing is printed, located at the right of the page, which width is expressed in mm.
Example:
This example sets the right margin for the SetupForMyPrint page setup to 12 mm. 
 SetupForMyPrint.RightMargin = 12
o Property Rotation() As
Returns or sets the rotation of the document or the image to print. Rotations angles can be 0, 90, 180, and 270 degrees counted clockwise.
Example:
This example sets the rotation to 90 degrees clockwise for the SetupForMyPrint page setup. 
 SetupForMyPrint.Rotation = catImageRotation90
o Property Scaling1To1() As
Returns or sets whether the document or the image should be printed with a zoom factor equals to 1 and the image to print lower left corner on the paper lower corner.
True if the document or the image is printed with the zoom factor equals to 1 and the image to print lower left corner on the paper lower corner. This overrides the location properties, that is Left and Bottom, and the Zoom property values.
Example:
This example requests to print the document or the image with the SetupForMyPrint page setup. 
 SetupForMyPrint.Scaling1To1 = True
o Property TextBlanking() As
Returns or sets the text blanking option in print Text will be printed in blanking rectangle Default value is FALSE
Example:
This example sets the text blanking option for the SetupForMyPrint page setup. 
 SetupForMyPrint.TextBlanking = True
o Property TextScaling() As
Returns or sets text scaling option for print. Default value is TRUE
Example:
This example sets text scaling option for the SetupForMyPrint page setup. 
 SetupForMyPrint.TextScaling = True
o Property TopMargin() As
Returns or sets the top margin. The top margin is a strip in which nothing is printed, located at the top of the page, which height is expressed in mm.
Example:
This example sets the top margin for the SetupForMyPrint page setup to 15 mm. 
 SetupForMyPrint.TopMargin = 15
o Property Use3DAccuracy() As
Returns or sets Use3DAccuracy option for print. Default value is FALSE
Example:
This example sets Use3DAccuracy option for the SetupForMyPrint page setup. 
 SetupForMyPrint.Use3DAccuracy = True
o Property UseImageSize() As
Returns or sets the paper size to the image size.
Example:
This example sets the paper size to image size for the SetupForMyPrint page setup. 
 SetupForMyPrint.UseImageSize = True
o Property WhiteVectorsInBlack() As
Returns or sets the white vectors in black option. white vectors will be printed in black if set to True Default value is TRUE
Example:
This example sets the Print White Vectors In Black option for the SetupForMyPrint page setup. 
 SetupForMyPrint.WhiteVectorsInBlack = True
o Property Zoom() As
Returns or sets the zoom factor to use when printing.
Example:
This example sets the zoom factor to 1.5 for the SetupForMyPrint page setup. 
 SetupForMyPrint.Zoom = 1.5

Copyright © 2003, Dassault Systèmes. All rights reserved.