GrapeCity.Documents.Pdf.AcroForms.Field

Field Class

Defines AcroForm field.

Inheritance

Field

Implements

IPdfDict

IOwnedObject

ActionHide.ILinkedObject

ActionFieldsBase.IFieldDef

Namespace: GrapeCity.Documents.Pdf.AcroForms

Assembly: DS.Documents.Pdf.dll

Syntax

public class Field : PdfDictWrapper, IPdfDict, IOwnedObject, ActionHide.ILinkedObject, ActionFieldsBase.IFieldDef

Public Class Field
    Inherits PdfDictWrapper
    Implements IPdfDict, IOwnedObject, ActionHide.ILinkedObject, ActionFieldsBase.IFieldDef

Constructors

Name	Description
Field()	Initializes a new instance of the Field class.

Properties

Name	Description
AcroForm	Gets the AcroForm that owns this object.
ActualJustification	Gets the actual justification to be used when displaying the field’s text.
AlternateName	Gets or sets an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.
CalculationIndex	Gets or sets an index that is used to determine the field's calculation order. Fields with lower indices are calculated before fields with higher indices. If several fields have the same CalculationIndex, the calculation order is determined by the order of fields in the collection. RecalculateValue can be used to specify JavaScript that is used to calculate the field's value.
Children	Gets the list of child fields.
DefaultValue	Gets or sets the field's default value.
Doc	Gets the GcPdfDocument owning this field.
Events	Gets the Field.TriggerEvents object defining events of this field.
Export	Gets or sets a value indicating whether the field must not be exported by a ActionSubmitForm action.
GcProps	Gets the PdfDict object that can be used to associate arbitrary data with this field. Note that for text values, in most cases the PdfString type should be used rather than string.
HasGcProps	Gets a value indicating whether the GcProps is not empty (i.e. whether this field has any associated custom properties).
Justification	Gets or sets the justification to be used in displaying the field’s text. Note that this field is used only if Justification is not specified.
MappingName	Gets or sets the mapping name to be used when exporting interactive form field data from the document.
Name	Gets or sets the field's name.
Owner	Gets the FieldCollection containing this field.
Parent	Gets the parent field.
PdfDefaultValue	Gets or sets the default field's value.
PdfValue	Gets or sets the field's value.
ReadOnly	Gets or sets a value indicating whether the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database.
Required	Gets or sets a value indicating whether the field must have a value at the time it is exported by a ActionSubmitForm action.
UserData	Gets or sets arbitrary data associated with the current field. Note that this data is runtime only and is not persisted in the PDF.
Value	Gets or sets the field's value.
Widgets	Gets the list of widget annotations associated with this field.

Methods

Name	Description
FormatDateTimeValue(DateTime, string)	Formats a DateTime value using the specified date format string. The syntax of the format string is similar to .NET format strings. Some examples are "m/d/yyyy" or "d-mmm-yy".
FormatNumberValue(double, int, NumberSeparatorStyle, NumberNegativeStyle, string, CurrencySymbolStyle)	Formats a value using the specified numeric formatting options.
FormatPercentValue(double, int, NumberSeparatorStyle)	Formats a value using the specified percentage formatting options.

Name

Description

FormatDateTimeValue(DateTime, string)

Formats a DateTime value using the specified date format string.

The syntax of the format string is similar to .NET format strings. Some examples are "m/d/yyyy" or "d-mmm-yy".

FormatNumberValue(double, int, NumberSeparatorStyle, NumberNegativeStyle, string, CurrencySymbolStyle)

Formats a value using the specified numeric formatting options.

FormatPercentValue(double, int, NumberSeparatorStyle)

Formats a value using the specified percentage formatting options.