Class WFormField

Summary description for WFormField.

Inheritance
System.Object
OwnerHolder
XDLSSerializableBase
Entity
WidgetBase
ParagraphItem
WTextRange
WField
WFormField
WCheckBox
WDropDownFormField
WTextFormField
Inherited Members
Namespace: Syncfusion.DocIO.DLS
Assembly: Syncfusion.DocIO.Base.dll
Syntax
public abstract class WFormField : WField, IXDLSSerializable, IOfficeRun, IStringWidget, ISplitLeafWidget, ITextMeasurable, IWField, IWTextRange, IParagraphItem, IEntity, ILeafWidget, IWidget

Constructors

WFormField(IWordDocument)

Initializes a new instance of the WFormField class.

Declaration
public WFormField(IWordDocument doc)
Parameters
Type Name Description
IWordDocument doc

WFormField(WFormField, IWordDocument)

Initializes a new instance of the WFormField class.

Declaration
protected WFormField(WFormField formField, IWordDocument doc)
Parameters
Type Name Description
WFormField formField

The form field.
IWordDocument doc

The doc.

Fields

m_curFormFieldType

Declaration
protected FormFieldType m_curFormFieldType
Field Value
Type
FormFieldType

Properties

CalculateOnExit

Gets/sets calculate on exit property.

Declaration
public bool CalculateOnExit { get; set; }
Property Value
Type
System.Boolean

Enabled

Gets or sets Enabled property (true if form field enabled).

Declaration
public bool Enabled { get; set; }
Property Value
Type
System.Boolean

FormFieldType

Gets type of this form field.

Declaration
public FormFieldType FormFieldType { get; }
Property Value
Type
FormFieldType

Help

Gets/sets form field help.

Declaration
public string Help { get; set; }
Property Value
Type
System.String

MacroOnEnd

Gets / sets the name of macros on end

Declaration
public string MacroOnEnd { get; set; }
Property Value
Type
System.String

MacroOnStart

Gets / sets the name of macros on start

Declaration
public string MacroOnStart { get; set; }
Property Value
Type
System.String

Name

Gets/sets form field title name (bookmark name).

Declaration
public string Name { get; set; }
Property Value
Type
System.String

StatusBarHelp

Gets or sets the status bar help.

Declaration
public string StatusBarHelp { get; set; }
Property Value
Type Description
System.String

The status bar help.

Methods

CloneImpl()

Clones itself.

Declaration
protected override object CloneImpl()
Returns
Type Description
System.Object

Returns cloned object.
Overrides

CreateLayoutInfo()

Declaration
protected override void CreateLayoutInfo()
Overrides

ReadXmlAttributes(IXDLSAttributeReader)

Reads object data from xml attributes.

Declaration
protected override void ReadXmlAttributes(IXDLSAttributeReader reader)
Parameters
Type Name Description
IXDLSAttributeReader reader

The IXDLSAttributeReader object.
Overrides

WriteXmlAttributes(IXDLSAttributeWriter)

Writes object data as xml attributes.

Declaration
protected override void WriteXmlAttributes(IXDLSAttributeWriter writer)
Parameters
Type Name Description
IXDLSAttributeWriter writer

The IXDLSAttributeWriter object.
Overrides

Implements