SnapEntity Interface

The base for classes that provide functionality to manipulate various entities in Snap documents.

Namespace: DevExpress.Snap.Core.API

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

Declaration

C#

public interface SnapEntity :
    IDisposable

VB.NET

Public Interface SnapEntity
    Inherits IDisposable

Related API Members

The following members accept/return SnapEntity objects:

• ISnapFieldOwner.ActiveEntity
• ISnapFieldOwner.ParseField(Field)
• ISnapFieldOwner.ParseField(Int32)

Remarks

For more information, refer to Developer Guidelines.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SnapEntity interface.

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-use-snapdocument-events-to-customize-the-default-templates-of-snap-lists-and-columns-e4782/CS/Snap_Events/Form1.cs#L132

Field field = e.Template.Fields[i];
SnapEntity eTemplateParseField = e.Template.ParseField(field);
SnapList snList = eTemplateParseField as SnapList;

VB.NET

how-to-use-snapdocument-events-to-customize-the-default-templates-of-snap-lists-and-columns-e4782/VB/Snap_Events/Form1.vb#L138

Dim field As Field = e.Template.Fields(i)
Dim eTemplateParseField As SnapEntity = e.Template.ParseField(field)
Dim snList As SnapList = TryCast(eTemplateParseField, SnapList)