Aspose::Pdf::PageNumberStamp class
Contents
[
Hide
]PageNumberStamp class
Represents page number stamp and used to number pages.
class PageNumberStamp : public Aspose::Pdf::TextStamp
Methods
| Method | Description |
|---|---|
| get_Background() const | 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. |
| get_BottomMargin() const | Gets bottom margin of stamp. |
| get_Draw() const | 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. |
| get_Format() const | String value for stamping page numbers. Value must include char ‘#’ which is replaced with the page number in the process of stamping. |
| get_Height() override | Desired height of the stamp on the page. |
| get_HorizontalAlignment() const | Gets Horizontal alignment of stamp on the page. |
| get_Justify() | Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false. |
| get_LeftMargin() const | Gets left margin of stamp. |
| get_MaxRowWidth() const | Max row height for WordWrap option. |
| get_NoCharacterBehavior() const | Gets mode that defines behavior in case fonts don’t contain requested characters. |
| get_NumberingStyle() const | Numbering style which used by this stamp. |
| get_Opacity() const | Gets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. |
| get_OutlineOpacity() const | Gets a value to indicate the stamp outline opacity. The value is from 0.0 to 1.0. By default the value is 1.0. |
| get_OutlineWidth() const | Gets a value of the stamp outline width. By default the value is 1.0. |
| get_ReplacementFont() const | Gets font used for replacing if user font does not contain required character. |
| get_RightMargin() const | Gets right margin of stamp. |
| get_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. |
| get_RotateAngle() | Gets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. |
| get_Scale() const | 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. |
| get_StartingNumber() const | Gets value of the number of starting page. Other pages will be numbered starting from this value. |
| get_TextAlignment() const | Alignment of the text inside the stamp. |
| get_TextState() const | Gets text properties of the stamp. See TextState for details. |
| get_TopMargin() const | Gets top margin of stamp. |
| get_TreatYIndentAsBaseLine() const | 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. |
| get_Value() | Gets string value which is used as stamp on the page. |
| get_VerticalAlignment() const | Gets vertical alignment of stamp on page. |
| get_Width() override | Desired width of the stamp on the page. |
| get_WordWrap() const | 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. |
| get_WordWrapMode() const | Gets the word wrap mode for text rendering. |
| get_XIndent() const | Horizontal stamp coordinate, starting from the left. |
| get_YIndent() const | Vertical stamp coordinate, starting from the bottom. |
| get_Zoom() const | 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. |
| get_ZoomX() const | Horizontal zooming factor of the stamp. Allows to scale stamp horizontally. |
| get_ZoomY() const | Vertical zooming factor of the stamp. Allows to scale stamp vertically. |
| getStampId() | Returns stamp ID. |
| PageNumberStamp(System::String) | Initializes a new instance of the PageNumberStamp class. |
| PageNumberStamp() | Initializes a new instance of the PageNumberStamp class. Format is set to “#”. |
| PageNumberStamp(System::SharedPtr<Facades::FormattedText>) | Creates PageNumberStamp by formatted text. |
| Put(System::SharedPtr<Page>) override | Adds page number. |
| set_Background(bool) | 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. |
| set_BottomMargin(double) | Sets bottom margin of stamp. |
| set_Draw(bool) | 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. |
| set_Format(System::String) | String value for stamping page numbers. Value must include char ‘#’ which is replaced with the page number in the process of stamping. |
| set_Height(double) override | Desired height of the stamp on the page. |
| set_HorizontalAlignment(Aspose::Pdf::HorizontalAlignment) | Sets Horizontal alignment of stamp on the page. |
| set_Justify(bool) | Defines text justification. If this property is set to true, both left and right edges of the text are aligned. Default value: false. |
| set_LeftMargin(double) | Sets left margin of stamp. |
| set_MaxRowWidth(double) | Max row height for WordWrap option. |
| set_NoCharacterBehavior(TextStamp::NoCharacterAction) | Sets mode that defines behavior in case fonts don’t contain requested characters. |
| set_NumberingStyle(Aspose::Pdf::NumberingStyle) | Numbering style which used by this stamp. |
| set_Opacity(double) | Sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0. |
| set_OutlineOpacity(double) | 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. |
| set_OutlineWidth(double) | Sets a value of the stamp outline width. By default the value is 1.0. |
| set_ReplacementFont(System::SharedPtr<Text::Font>) | Sets font used for replacing if user font does not contain required character. |
| set_RightMargin(double) | Sets right margin of stamp. |
| set_Rotate(Rotation) | 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. |
| set_RotateAngle(double) | Sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. |
| set_Scale(bool) | 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. |
| set_StartingNumber(int32_t) | Sets value of the number of starting page. Other pages will be numbered starting from this value. |
| set_TextAlignment(Aspose::Pdf::HorizontalAlignment) | Alignment of the text inside the stamp. |
| set_TopMargin(double) | Sets top margin of stamp. |
| set_TreatYIndentAsBaseLine(bool) | 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. |
| set_Value(System::String) | Sets string value which is used as stamp on the page. |
| set_VerticalAlignment(Aspose::Pdf::VerticalAlignment) | Sets vertical alignment of stamp on page. |
| set_Width(double) override | Desired width of the stamp on the page. |
| set_WordWrap(bool) | 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. |
| set_WordWrapMode(Aspose::Pdf::Text::TextFormattingOptions::WordWrapMode) | Sets the word wrap mode for text rendering. |
| set_XIndent(double) | Horizontal stamp coordinate, starting from the left. |
| set_YIndent(double) | Vertical stamp coordinate, starting from the bottom. |
| set_Zoom(double) | 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. |
| set_ZoomX(double) | Horizontal zooming factor of the stamp. Allows to scale stamp horizontally. |
| set_ZoomY(double) | Vertical zooming factor of the stamp. Allows to scale stamp vertically. |
| setStampId(int32_t) | Sets stamp Id. |
| Stamp() | |
| TextStamp(System::String) | Initializes a new instance of the TextStamp class. |
| TextStamp(System::String, System::SharedPtr<Aspose::Pdf::Text::TextState>) | Initializes a new instance of the TextStamp class. |
| TextStamp(System::SharedPtr<Facades::FormattedText>) | Initializes a new instance of the TextStamp class with formattedText object. |
See Also
- Class TextStamp
- Namespace Aspose::Pdf
- Library Aspose.PDF for C++