PdfStampAppearance Class

Namespace:
GemBox.Pdf.Annotations
Assembly:
GemBox.Pdf.dll

Represents an appearance settings for a PdfStampAnnotation.

public sealed class PdfStampAppearance : PdfAppearance
Public NotInheritable Class PdfStampAppearance
    Inherits PdfAppearance
Inheritance:
System.Object
PdfStampAppearance

Properties

Date

Gets or sets the time of stamping.

Applicable for: DynamicRevised, DynamicReviewed, DynamicReceived, and DynamicApproved.

If null, value System.DateTimeOffset.Now is used.

public DateTimeOffset? Date { get; set; }
Public Property Date As DateTimeOffset?
Property Value
System.Nullable<System.DateTimeOffset>

The time of stamping.

DateFormat

Gets or sets the Date format string.

Applicable for: DynamicRevised, DynamicReviewed, DynamicReceived, and DynamicApproved.

If null, value "h:mm tt, MMM dd, yyyy" is used.

public string DateFormat { get; set; }
Public Property DateFormat As String
Property Value
System.String

The Date format string.

DateFormatProvider

Gets or sets the Date culture-specific formatting provider.

Applicable for: DynamicRevised, DynamicReviewed, DynamicReceived, and DynamicApproved.

If null, value System.Globalization.CultureInfo.CurrentCulture is used.

public IFormatProvider DateFormatProvider { get; set; }
Public Property DateFormatProvider As IFormatProvider
Property Value
System.IFormatProvider

The Date culture-specific formatting provider.

Icon

(Optional) The icon that shall be used in displaying the PdfStampAnnotation.

Default value: Draft.

public PdfStampIcon Icon { get; }
Public ReadOnly Property Icon As PdfStampIcon
Property Value
PdfStampIcon

The icon that shall be used in displaying the PdfStampAnnotation.

See Also

Name

Gets or sets the name of the person or authority stamping the document.

Applicable for: DynamicReviewed, DynamicReceived, and DynamicApproved.

If null, value System.String.Empty is used.

public string Name { get; set; }
Public Property Name As String
Property Value
System.String

The name of the person or authority stamping the document.

NameAndDateLabelFormat

Gets or sets the format of the Name and Date label.

Applicable for: DynamicReviewed, DynamicReceived, and DynamicApproved.

If null, value "By {0} at {1}" is used.

public string NameAndDateLabelFormat { get; set; }
Public Property NameAndDateLabelFormat As String
Property Value
System.String

The format of the Name and Date label.

Opacity

Gets or sets the opacity.

Default value: 1.0.

public double Opacity { get; set; }
Public Property Opacity As Double
Property Value
System.Double

The opacity.

OrganizationName

Gets or sets the organization name of the person or authority stamping the document.

Applicable for: DynamicConfidential.

If null, value System.String.Empty is used.

public string OrganizationName { get; set; }
Public Property OrganizationName As String
Property Value
System.String

The organization name of the person or authority stamping the document.

Inherited Properties

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, System.Collections.Generic.ICollection<System.Collections.Generic.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)

See Also