ISnapFieldOwner.ParseField(Field) Method

Converts the fields of a RichEditControl to Snap fields.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v19.2.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.

Refer to Snap Fields article for more information about 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.

The code sample below shows how to use the ISnapFieldOwner.ParseField method to convert a SnapList’s row template to paragraphs.

C#

using System;
using System.Collections.Generic;
using System.Data;
using DevExpress.Snap.Core.API;

//...

List<DataFieldInfo> dataFields;

void Document_BeforeInsertSnList(object sender, BeforeInsertSnListEventArgs e)
{
    //Fill the data fields collection
    this.dataFields = e.DataFields;
}
void Document_PrepareSnList(object sender, PrepareSnListEventArgs e)
{
    for (int i = 0; i < e.Template.Fields.Count; i++)
    {
        //Convert each field to snap field
        SnapList list = e.Template.ParseField(field) as SnapList;

        //Check whether the returned object is not null
        if(list !=null)
        {
            //Open the snap entity for modification:
            list.BeginUpdate();

            //Clear the list header and row templates:
            list.ListHeader.Delete(list.ListHeader.Range);
            SnapDocument template = list.RowTemplate;
            template.Delete(template.Range);

            //Insert each data field as simple text:
            foreach(DataFieldInfo dataField in this.dataFields)
            {
                template.AppendText(string.Format("{0} = ", dataField.DisplayName));
                template.CreateSnText(template.Range.End, dataField.DataPaths[dataField.DataPaths.Length - 1]);
                template.AppendParagraph();
            }

            //Insert a new paragraph:
            template.AppendParagraph();

            //End the list's update:
            list.EndUpdate();
        }
    }
    this.dataFields = null;
}

VB.NET

Imports System
Imports System.Collections.Generic
Imports System.Data
Imports DevExpress.Snap.Core.API

'...

Private dataFields As List(Of DataFieldInfo)

Private Sub Document_BeforeInsertSnList(ByVal sender As Object, ByVal e As BeforeInsertSnListEventArgs)
  'Fill the data fields collection
  Me.dataFields = e.DataFields
End Sub
Private Sub Document_PrepareSnList(ByVal sender As Object, ByVal e As PrepareSnListEventArgs)
    For i As Integer = 0 To e.Template.Fields.Count - 1
        'Convert each field to snap field
        Dim list As SnapList = TryCast(e.Template.ParseField(field), SnapList)

        'Check whether the returned object is not null
        If list IsNot Nothing Then
            'Open the snap entity for modification:
            list.BeginUpdate()

            'Clear the list header and row templates:
            list.ListHeader.Delete(list.ListHeader.Range)
            Dim template As SnapDocument = list.RowTemplate
            template.Delete(template.Range)

            'Insert each data field as simple text:
            For Each dataField As DataFieldInfo In Me.dataFields
                template.AppendText(String.Format("{0} = ", dataField.DisplayName))
                template.CreateSnText(template.Range.End, dataField.DataPaths(dataField.DataPaths.Length - 1))
                template.AppendParagraph()
            Next dataField

            'Insert a new paragraph:
            template.AppendParagraph()

            'End the list's update:
            list.EndUpdate()
        End If
    Next i
    Me.dataFields = Nothing
End Sub

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