SnapEntity.EndUpdate() Method

Unlocks the SnapEntity after a call to the SnapEntity.BeginUpdate method and causes an immediate visual update of the object.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v18.2.Core.dll

Declaration

C#

void EndUpdate()

VB.NET

Sub

Remarks

Each Snap field in a document corresponds to a specific SnapEntity that is returned by the ISnapFieldOwner.ParseField method. Any modification of an entity at runtime must be wrapped in the SnapEntity.BeginUpdate and EndUpdate method calls.

After calling the SnapEntity.BeginUpdate method, the SnapEntity.Active property becomes enabled until the EndUpdate method is called. A document can only contain one active entity at one time.

The following requirements apply to the proper customization of a SnapEntity at runtime.

• To learn whether or not the customization is opened for an entity, consult its SnapEntity.Active property value.

  To learn whether or not the customization is opened for a specific entity, use the ISnapFieldOwner.ActiveEntity property.

• To open an entity for runtime customization, call its SnapEntity.BeginUpdate method.

  To apply the new settings, call the EndUpdate method.

Do not call the EndUpdate method for a parent entity until there is no active nested entity left within it.

Nested Fields

If a document contains multiple entities that are nested inside each other (e.g., in case of a master-detail report), only the outermost (parent) field in this document is active.

The parent field’s data is contained in one or more SnapDocument objects assigned to the field templates (e.g., SnapList.RowTemplate, SnapListGroupInfo.Header, or SnapListGroupInfo.Footer).

To modify the content of a nested field within a parent field’s document, do the following.

1. Obtain the nested field from a corresponding SnapDocument.
2. Parse the field by calling the ISnapFieldOwner.ParseField method that returns the appropriate SnapEntity.
3. Call the SnapEntity.BeginUpdate method of the returned entity.
4. After making the required changes, make sure to call the EndUpdate method for the nested entity.
5. Call the EndUpdate method for the parent entity.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EndUpdate() 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-generate-a-live-report-based-on-gridcontrol-content-t272175/CS/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.cs#L74

    list.ApplyTableStyles(level);
    list.EndUpdate();
}

snap-report-api-getting-started-t432062/CS/SnapServerGettingStarted/Program.cs#L60

list.EndUpdate();
list.Field.Update();

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

list.EndUpdate();
list.Field.Update();

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

snImage.ScaleY = snImage.ScaleY * 2;
snImage.EndUpdate();
item.Update();

VB.NET

how-to-generate-a-live-report-based-on-gridcontrol-content-t272175/VB/WindowsFormsApplication1/GridReportExtensions/SnapReportForGridGenerator.vb#L77

    list.ApplyTableStyles(level)
    list.EndUpdate()
End Sub

snap-report-api-getting-started-t432062/VB/SnapServerGettingStarted/Program.vb#L50

list.EndUpdate()
list.Field.Update()

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

list.EndUpdate()
list.Field.Update()

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

snImage.ScaleY = snImage.ScaleY * 2
snImage.EndUpdate()
item.Update()