Aspose::Pdf::TextStamp class

TextStamp class

Represents textual stamp.

class TextStamp : public Aspose::Pdf::Stamp

Enums

EnumDescription
NoCharacterActionAction to perform if font does not contain required character.

Methods

MethodDescription
get_AutoAdjustFontSizePrecision() constAutomatically adjust font size precision. Default value: 0.1;.
get_AutoAdjustFontSizeToFitStampRectangle() constIf enabled, the font size will be automatically adjusted to fit the stamp rectangle of size: Width and Height. Default width and height are derived from the page rectangle.
get_Draw() constThis 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_FontSize()Actual font size after the stamp has been placed. (May differ from the initial font size provided through the constructor if the ‘AutoAdjustFontSizeToFitStampRectangle’ option is enabled.)
get_Height() overrideDesired height of the 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_MaxRowWidth() constMax row height for WordWrap option.
get_NoCharacterBehavior() constGets mode that defines behavior in case fonts don’t contain requested characters.
get_ReplacementFont() constGets font used for replacing if user font does not contain required character.
get_Scale() constDefines 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_TextAlignment() constAlignment of the text inside the stamp.
get_TextState() constGets text properties of the stamp. See TextState for details.
get_TreatYIndentAsBaseLine() constDefines 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_Width() overrideDesired width of the stamp on the page.
get_WordWrap() constDefines 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() constGets the word wrap mode for text rendering.
Put(System::SharedPtr<Page>) overrideAdds textual stamp on the page.
set_AutoAdjustFontSizePrecision(float)Automatically adjust font size precision. Default value: 0.1;.
set_AutoAdjustFontSizeToFitStampRectangle(bool)If enabled, the font size will be automatically adjusted to fit the stamp rectangle of size: Width and Height. Default width and height are derived from the page rectangle.
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_Height(double) overrideDesired height of the 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_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_ReplacementFont(System::SharedPtr<Text::Font>)Sets font used for replacing if user font does not contain required character.
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_TextAlignment(Aspose::Pdf::HorizontalAlignment)Alignment of the text inside the 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_Width(double) overrideDesired 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.
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