Document Solutions for PDF
DS.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.AcroForms Namespace / Field Class
Properties Methods

In This Topic
    Field Class Members
    In This Topic

    The following tables list the members exposed by Field.

    Public Constructors
     NameDescription
    Public ConstructorField ConstructorInitializes a new instance of the Field class.  
    Top
    Public Properties
     NameDescription
    Public PropertyAcroFormGets the AcroForm that owns this object.  
    Public PropertyActualJustificationGets the actual justification to be used when displaying the field’s text.  
    Public PropertyAlternateNameGets 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.  
    Public PropertyCalculationIndexGets 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.

    Field.TriggerEvents.RecalculateValue can be used to specify JavaScript that is used to calculate the field's value.

     
    Public PropertyChildrenGets the list of child fields.  
    Public PropertyDefaultValueGets or sets the field's default value.  
    Public PropertyDocGets the GrapeCity.Documents.Pdf.GcPdfDocument owning this field.  
    Public PropertyEventsGets the Field.TriggerEvents object defining events of this field.  
    Public PropertyExportGets or sets a value indicating whether the field must not be exported by a GrapeCity.Documents.Pdf.Actions.ActionSubmitForm action.  
    Public PropertyGcPropsGets the GrapeCity.Documents.Pdf.Spec.PdfDict object that can be used to associate arbitrary data with this field.

    Note that for text values, in most cases the GrapeCity.Documents.Pdf.Spec.PdfString type should be used rather than System.String.

     
    Public PropertyHasGcPropsGets a value indicating whether the GcProps is not empty (i.e. whether this filed has any associated custom properties).  
    Public PropertyJustificationGets or sets the justification to be used in displaying the field’s text.

    Note that this field is used only if GrapeCity.Documents.Pdf.Annotations.WidgetAnnotation.Justification is not specified.

     
    Public PropertyMappingNameGets or sets the mapping name to be used when exporting interactive form field data from the document.  
    Public PropertyNameGets or sets the field's name.  
    Public PropertyObjIDGets the PDF object ID. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public PropertyOwnerGets the FieldCollection containing this field.  
    Public PropertyParentGets the parent field.  
    Public PropertyPdfDefaultValueGets or sets the default field's value.  
    Public PropertyPdfDictGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfDict. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfDictWrapper)
    Public PropertyPdfObjectGets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapper<IPdfDict>)
    Public PropertyPdfValueGets or sets the field's value.  
    Public PropertyReadOnlyGets 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.  
    Public PropertyRequiredGets or sets a value indicating whether the field must have a value at the time it is exported by a GrapeCity.Documents.Pdf.Actions.ActionSubmitForm action.  
    Public PropertyUserDataGets or sets arbitrary data associated with the current field.

    Note that this data is runtime only and is not persisted in the PDF.

     
    Public PropertyValueGets or sets the field's value.  
    Public PropertyWidgetsGets the list of widget annotations associated with this field.  
    Top
    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)FormatDateTimeValueFormats a System.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".

     
    Public Methodstatic (Shared in Visual Basic)FormatNumberValueFormats a value using the specified numeric formatting options.  
    Public Methodstatic (Shared in Visual Basic)FormatPercentValueFormats a value using the specified percentage formatting options.  
    Public MethodGetPdfStreamGets the System.IO.Stream object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetPdfStreamDataGets the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Public MethodGetPdfStreamInfoGets the GrapeCity.Documents.Pdf.Spec.PdfStreamInfo object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase)
    Top
    See Also

    Reference

    Field Class
    GrapeCity.Documents.Pdf.AcroForms Namespace