PageNumberStamp

PageNumberStamp class

Represents page number stamp and used to number pages.

public sealed class PageNumberStamp : TextStamp

Constructors

Name Description
PageNumberStamp() Initializes a new instance of the PageNumberStamp class. Format is set to “#”.
PageNumberStamp(FormattedText) Creates PageNumberStamp by formatted text.
PageNumberStamp(string) Initializes a new instance of the PageNumberStamp class.

Properties

Name Description
Background { get; set; } Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top.
BottomMargin { get; set; } Gets or sets bottom margin of stamp.
Draw { get; set; } This property determines how stamp is drawn on page. If Draw = true stamp is drawn as graphic operators and if draw = false then stamp is drawn as text.
Format { get; set; } String value for stamping page numbers. Value must include char ‘#’ which is replaced with the page number in the process of stamping.
override Height { get; set; } Desired height of the stamp on the page.
HorizontalAlignment { get; set; } Gets or sets Horizontal alignment of stamp on the page.
Justify { get; set; } Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false.
LeftMargin { get; set; } Gets or sets left margin of stamp.
MaxRowWidth { get; set; } Max row height for WordWrap option.
NumberingStyle { get; set; } Numbering style which used by this stamp.
Opacity { get; set; } Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0.
OutlineOpacity { get; set; } Gets or sets a value to indicate the stamp outline opacity. The value is from 0.0 to 1.0. By default the value is 1.0.
OutlineWidth { get; set; } Gets or sets a value of the stamp outline width. By default the value is 1.0.
RightMargin { get; set; } Gets or sets right margin of stamp.
Rotate { get; set; } Sets or gets the rotation of stamp content according Rotation values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property. If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
RotateAngle { get; set; } Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle.
Scale { get; set; } Defines scaling of the text. If this property is set to true and Width value specified, text will be scaled in order to fit to specified width.
StartingNumber { get; set; } Gets or sets value of the number of starting page. Other pages will be numbered starting from this value.
TextAlignment { get; set; } Alignment of the text inside the stamp.
TextState { get; } Gets text properties of the stamp. See TextState for details.
TopMargin { get; set; } Gets or sets top margin of stamp.
TreatYIndentAsBaseLine { get; set; } Defines coordinate origin for placing text. If TreatYIndentAsBaseLine = true (default when Draw = true) YIndent value will be treated as text base line. If TreatYIndentAsBaseLine = false (default when Draw = false) YIndent value will be treated as bottom (descent line) of text.
Value { get; set; } Gets or sets string value which is used as stamp on the page.
VerticalAlignment { get; set; } Gets or sets vertical alignment of stamp on page.
override Width { get; set; } Desired width of the stamp on the page.
WordWrap { get; set; } Defines word wrap. If this property set to true and Width value specified, text will be broken in the several lines to fit into specified width. Default value: false.
XIndent { get; set; } Horizontal stamp coordinate, starting from the left.
YIndent { get; set; } Vertical stamp coordinate, starting from the bottom.
Zoom { get; set; } Zooming factor of the stamp. Allows to scale stamp. Please note that pair of properties ZoomX and ZoomY allows to set zoom factor for every axe separately. Setting of this property changes both ZoomX and ZoomY properties. If ZoomX and ZoomY are different then Zoom property returns ZoomX value.
ZoomX { get; set; } Horizontal zooming factor of the stamp. Allows to scale stamp horizontally.
ZoomY { get; set; } Vertical zooming factor of the stamp. Allows to scale stamp vertically.

Methods

Name Description
getStampId() Returns stamp ID.
override Put(Page) Adds page number.
setStampId(int) Sets stamp Id.

See Also