BeforeClearFieldEventArgs Class

Inheritance

System.Object

BeforeClearFieldEventArgs

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.DocIO.DLS

Assembly: Syncfusion.DocIO.Base.dll

Syntax

public class BeforeClearFieldEventArgs

Constructors

BeforeClearFieldEventArgs(WordDocument, String, Int32, IWMergeField, Boolean, Object)

Initialize the new instance of BeforeClearFieldEventArgs class for the specified document with table name, row index, field and its value.

Declaration

public BeforeClearFieldEventArgs(WordDocument doc, string groupName, int rowIndex, IWMergeField field, bool fieldHasMappedInDataSource, object value)

Parameters

Type	Name	Description
WordDocument	doc	IWordDcoument instance
System.String	groupName	The groupName of table
System.Int32	rowIndex	The row index of the table
IWMergeField	field	The current Merge Field
System.Boolean	fieldHasMappedInDataSource	The current Row enumerator
System.Object	value	The current Field value

Properties

ClearField

Gets or sets a Boolean value whether the unmerged merge field can be clear or not.

Declaration

public bool ClearField { get; set; }

Property Value

Type	Description
System.Boolean	True, Remove the unmerged fields, otherwise False

CurrentMergeField

Gets the current merge field. Read-only.

Declaration

public IWMergeField CurrentMergeField { get; }

Property Value

Type
IWMergeField

FieldName

Gets the merge field Name. Read-only.

Declaration

public string FieldName { get; }

Property Value

Type	Description
System.String	The string that specifies the merge field name.

FieldValue

Gets or sets the merge field value.

Declaration

public object FieldValue { get; set; }

Property Value

Type	Description
System.Object	An System.Object that specifies the field value.

GroupName

Gets the owner group name of the merge field.

Declaration

public string GroupName { get; }

Property Value

Type
System.String

HasMappedFieldInDataSource

Gets a Boolean value whether the merge field has mapped field in data source or not.

Declaration

public bool HasMappedFieldInDataSource { get; }

Property Value

Type	Description
System.Boolean	True, if the merge field has mapped field in data source. Otherwise false.

RowIndex

Gets the row index. Read-only.

Declaration

public int RowIndex { get; }

Property Value

Type	Description
System.Int32	The integer that specifies the row index.