PdfVariableTextAppearance Class
Represents an appearance settings for a variable text fields PdfTextField, PdfDropdownField and PdfListBoxField.
public sealed class PdfVariableTextAppearance : PdfFieldAppearance
Public NotInheritable Class PdfVariableTextAppearance
Inherits PdfFieldAppearance
- Inheritance:
- PdfVariableTextAppearance
Properties
BackgroundColor
Gets or sets the background color of the variable text field appearance.
Property Value
Exceptions
The value's Space is not device color space (DeviceGray, DeviceRGB, or DeviceCMYK).
See Also
BorderColor
Gets or sets the border color of the variable text field appearance.
Property Value
Exceptions
The value's Space is not device color space (DeviceGray, DeviceRGB, or DeviceCMYK).
See Also
BorderDashPattern
Gets or sets the border dash pattern of the variable text field appearance.
public PdfLineDashPattern BorderDashPattern { get; set; }
Public Property BorderDashPattern As PdfLineDashPattern
Property Value
The border dash pattern of the variable text field appearance.
See Also
BorderStyle
Gets or sets the border style of the variable text field appearance.
public PdfBorderStyle BorderStyle { get; set; }
Public Property BorderStyle As PdfBorderStyle
Property Value
The border style of the variable text field appearance.
Exceptions
Value Unknown of enumeration PdfBorderStyle is not supported in the requested operation.
See Also
BorderWidth
Gets or sets the border thickness of the variable text field appearance.
Property Value
The border thickness of the variable text field appearance.
Exceptions
Value is less than 0.
Value is either NaN, NegativeInfinity or PositiveInfinity.
See Also
FontColor
Gets or sets the font color of the field's appearance text.
Property Value
The font color of the field's appearance text.
FontFace
Gets or sets the font face of the field's appearance text.
Property Value
The font face of the field's appearance text.
Exceptions
Value is null.
FontSize
Gets or sets the font size of the field's appearance text.
A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle.
Property Value
The font size of the field's appearance text.
Exceptions
Value is either NaN, NegativeInfinity or PositiveInfinity.
Value is less than 0.
LineHeight
Gets or sets the line height, or line spacing, between lines of the PdfTextField appearance text (if the MultiLine is true).
Default value: 0 (the default line height is automatically calculated, and is based on the FontFace and the FontSize).
Property Value
The line height, or line spacing, between lines of the PdfTextField appearance text.
Exceptions
Value is less than zero.
TextAlignment
Gets or sets the text alignment of the field's appearance text.
public PdfTextAlignment TextAlignment { get; set; }
Public Property TextAlignment As PdfTextAlignment
Property Value
The text alignment of the field's appearance text.
Exceptions
Inherited Properties
Orientation | (Optional) The number of degrees by which the widget annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. Default value: 0. (Inherited from PdfFieldAppearance) |
State | (Required if the appearance dictionary AP contains one or more subdictionaries; PDF 1.2) The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary (see Section 12.5.5, "Appearance Streams"). (Inherited from PdfAppearance) |
Inherited Methods
BeginInit() | Begins initialization of the PdfAppearance. Call EndInit() to end the initialization and update the appearance. If BeginInit() is called on a PdfAppearance that is already being initialized, the second and subsequent calls are ignored. (Inherited from PdfAppearance) |
EndInit() | Ends initialization of the PdfAppearance by updating the changed appearance. This method will be ignored if called on a PdfAppearance that is not being initialized. (Inherited from PdfAppearance) |
Get() | Gets the appearance form for the Normal appearance trigger and the current appearance State. (Inherited from PdfAppearance) |
Get(PdfAppearanceTrigger) | Gets a collection of appearance states and the associated appearance forms for the specified appearance trigger. (Inherited from PdfAppearance) |
Get(PdfAppearanceTrigger, PdfAppearanceState) | Gets the appearance form for the specified appearance trigger and appearance state. (Inherited from PdfAppearance) |
Refresh() | Forces an update of the appearance. (Inherited from PdfAppearance) |
Set(PdfAppearanceTrigger, ICollection<KeyValuePair<PdfAppearanceState, PdfForm>>) | Sets a collection of appearance states and the associated appearance forms for the specified appearance trigger. (Inherited from PdfAppearance) |
Set(PdfAppearanceTrigger, PdfAppearanceState, PdfForm) | Sets the appearance form for the specified appearance trigger and appearance state. (Inherited from PdfAppearance) |
Set(PdfForm) | Sets the appearance form for the Normal appearance trigger and the current appearance State. (Inherited from PdfAppearance) |