PageNumberStamp Class - Aspose.PDF for .NET

PageNumberStamp Class

Represents page number stamp and used to number pages.

Inheritance Hierarchy

SystemObject
  Aspose.PdfStamp
    Aspose.PdfTextStamp
      Aspose.PdfPageNumberStamp

Namespace: Aspose.Pdf
Assembly: Aspose.PDF (in Aspose.PDF.dll) Version: 20.3

Syntax

C++

public sealed class PageNumberStamp : TextStamp

Public NotInheritable Class PageNumberStamp
	Inherits TextStamp

public ref class PageNumberStamp sealed : public TextStamp

[<SealedAttribute>]
type PageNumberStamp =  
    class
        inherit TextStamp
    end

The PageNumberStamp type exposes the following members.

Constructors

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

Properties

	Name	Description
	Background	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. (Inherited from Stamp.)
	BottomMargin	Gets or sets bottom margin of stamp. (Inherited from Stamp.)
	Draw	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. (Inherited from TextStamp.)
	Format	String value for stamping page numbers. Value must include char '#' which is replaced with the page number in the process of stamping.
	Height	Desired height of the stamp on the page. (Inherited from TextStamp.)
	HorizontalAlignment	Gets or sets Horizontal alignment of stamp on the page. (Inherited from Stamp.)
	Justify	Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false. (Inherited from TextStamp.)
	LeftMargin	Gets or sets left margin of stamp. (Inherited from Stamp.)
	MaxRowWidth	Max row height for WordWrap option. (Inherited from TextStamp.)
	NumberingStyle	Numbering style which used by this stamp.
	Opacity	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. (Inherited from Stamp.)
	OutlineOpacity	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. (Inherited from Stamp.)
	OutlineWidth	Gets or sets a value of the stamp outline width. By default the value is 1.0. (Inherited from Stamp.)
	RightMargin	Gets or sets right margin of stamp. (Inherited from Stamp.)
	Rotate	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. (Inherited from Stamp.)
	RotateAngle	Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. (Inherited from Stamp.)
	Scale	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. (Inherited from TextStamp.)
	StartingNumber	Gets or sets value of the number of starting page. Other pages will be numbered starting from this value.
	TextAlignment	Alignment of the text inside the stamp. (Inherited from TextStamp.)
	TextState	Gets text properties of the stamp. See TextState for details. (Inherited from TextStamp.)
	TopMargin	Gets or sets top margin of stamp. (Inherited from Stamp.)
	TreatYIndentAsBaseLine	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. (Inherited from TextStamp.)
	Value	Gets or sets string value which is used as stamp on the page. (Inherited from TextStamp.)
	VerticalAlignment	Gets or sets vertical alignment of stamp on page. (Inherited from Stamp.)
	Width	Desired width of the stamp on the page. (Inherited from TextStamp.)
	WordWrap	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. (Inherited from TextStamp.)
	XIndent	Horizontal stamp coordinate, starting from the left. (Inherited from Stamp.)
	YIndent	Vertical stamp coordinate, starting from the bottom. (Inherited from Stamp.)
	Zoom	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. (Inherited from Stamp.)
	ZoomX	Horizontal zooming factor of the stamp. Allows to scale stamp horizontally. (Inherited from Stamp.)
	ZoomY	Vertical zooming factor of the stamp. Allows to scale stamp vertically. (Inherited from Stamp.)

Methods

	Name	Description
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	getStampId	Returns stamp ID. (Inherited from Stamp.)
	GetType	(Inherited from Object.)
	Put	Adds page number. (Overrides TextStampPut(Page).)
	setStampId	Sets stamp Id. (Inherited from Stamp.)
	ToString	(Inherited from Object.)

Reference

Aspose.Pdf Namespace