MergeImageFieldEventArgs Class

Represents the MergeImageField event that occurs during Mail merge.

Inheritance
System.Object
System.EventArgs
MergeFieldEventArgs
MergeImageFieldEventArgs
Inherited Members
System.EventArgs.Empty
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 MergeImageFieldEventArgs : MergeFieldEventArgs

Constructors

MergeImageFieldEventArgs(IWordDocument, String, Int32, IWMergeField, Image)

Initializes a new instance of MergeImageFieldEventArgs class for the specified Word document with table name, row index, field instance and the image.

Declaration
public MergeImageFieldEventArgs(IWordDocument doc, string tableName, int rowIndex, IWMergeField field, Image image)
Parameters
Type Name Description
IWordDocument doc

The IWordDocument instance.
System.String tableName

The name of the table to perform merge.
System.Int32 rowIndex

The row index in the table.
IWMergeField field

The IWMergeField instance.
System.Drawing.Image image

The System.Drawing.Image instance.

MergeImageFieldEventArgs(IWordDocument, String, Int32, IWMergeField, Object)

Initializes a new instance of MergeImageFieldEventArgs class for the specified Word document with table name, row index, field instance and the image.

Declaration
public MergeImageFieldEventArgs(IWordDocument doc, string tableName, int rowIndex, IWMergeField field, object obj)
Parameters
Type Name Description
IWordDocument doc

The IWordDocument instance.
System.String tableName

The name of the table to perform merge.
System.Int32 rowIndex

The row index in the table.
IWMergeField field

The IWMergeField instance.
System.Object obj

An System.Object that specifies image.

Properties

Image

Gets or sets the image.

Declaration
public Image Image { get; set; }
Property Value
Type Description
System.Drawing.Image

System.Drawing.Image that specifies the image.

ImageFileName

Gets or sets the image file name.

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

The string that specifies the image file name.

ImageStream

Gets or sets the image stream.

Declaration
public Stream ImageStream { get; set; }
Property Value
Type Description
System.IO.Stream

The System.IO.Stream that represents the image stream.

Picture

Gets the Current Picture. Read-only

Declaration
public WPicture Picture { get; }
Property Value
Type
WPicture

Skip

Gets or sets a value indicating whether this MergeImageFieldEventArgs is skip.

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

True if skip; otherwise, false.

UseText

Gets a value indicating whether to use text. Read-only.

Declaration
public bool UseText { get; }
Property Value
Type Description
System.Boolean

True if to use the text; otherwise, false.