ISnapFieldOwner.ParseField(Field) Method

Converts the fields of a RichEditControl to Snap fields.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v19.1.Core.dll

Declaration

C#

SnapEntity ParseField(
    Field field
)

VB.NET

Function ParseField(
    field As Field
) As SnapEntity

Parameters

Name	Type	Description
field	Field	A Field object.

Returns

Type	Description
SnapEntity	A SnapEntity descendant.

Remarks

Any modification of a SnapEntity at runtime must be wrapped in the SnapEntity.BeginUpdate and SnapEntity.EndUpdate method calls.

To learn about Snap fields, refer to Snap Fields.

To learn about RichEditControl‘s fields, refer to Fields and Field Codes.

Note

The SnapEntity descendant object cannot be processed after the document has been changed. Call the ParseField method every time the field needs to be modified.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ParseField(Field) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-edit-an-existing-snx-template-in-code-t224149/CS/Snap_API/Form1.cs#L60

list = snapControl1.Document.ParseField(field) as SnapList;
if(object.ReferenceEquals(list, null))

how-to-automatically-create-mail-merge-documents-using-the-snap-report-api-e5078/CS/MailMergeServer/Program.cs#L79

DevExpress.XtraRichEdit.API.Native.Field item = e.RecordDocument.Fields[i];
SnapImage snImage = e.RecordDocument.ParseField(item) as SnapImage;
if (snImage != null)

VB.NET

how-to-edit-an-existing-snx-template-in-code-t224149/VB/Snap_API/Form1.vb#L62

list = TryCast(snapControl1.Document.ParseField(field), SnapList)
If Object.ReferenceEquals(list, Nothing) Then

how-to-automatically-create-mail-merge-documents-using-the-snap-report-api-e5078/VB/MailMergeServer/Program.vb#L70

Dim item As API.Native.Field = e.RecordDocument.Fields(i)
Dim snImage As SnapImage = TryCast(e.RecordDocument.ParseField(item), SnapImage)
If snImage IsNot Nothing Then