Skip to main content

SnapText Members

Provides functionality to manipulate text in Snap documents.

Name	Description
Active	Indicates whether or not the SnapEntity is locked. Inherited from SnapEntity.
DataFieldName	Specifies the name of a data field that is assigned to the Snap field. Inherited from SnapSingleListItemEntity.
Document	Provides access to a SnapDocument, to which the SnapEntity belongs. Inherited from SnapEntity.
EmptyFieldDataAlias	Specifies the text to show in a document instead of a blank space if a Snap field receives an empty data source record. Inherited from SnapSingleListItemEntity.
EnableEmptyFieldDataAlias	Enables the application displaying a custom text instead of a blank space if a Snap field receives an empty data source record. Inherited from SnapSingleListItemEntity.
Field	Provides access to a Field associated with the SnapEntity. Inherited from SnapEntity.
FieldName	Obsolete. Specifies the name of a data field that is bound to the SnapText.
FormatString	Specifies a string format applied to the SnapText.
IsParameter	Gets or sets whether the data field associated with a SnapEntity object is a parameter. Inherited from SnapSingleListItemEntitySupportsParameters.
KeepLastParagraph	Specifies whether or not to insert the current paragraph spacing after its last occurrence in the document.
SubDocument	Provides access to an object implementing the basic document functionality that is common for the header, footer and the main document body. Inherited from SnapEntity.
SummaryFunc	Specifies a summary function applied to the SnapText.
SummaryIgnoreNullValues	Specifies whether or not to ignore empty fields when calculating a summary for the SnapText.
SummaryRunning	Specifies the range across which a summary function is calculated.
TextAfterIfFieldNotBlank	Specifies the text added to the SnapText after the content obtained from the bound data field (if this content is not empty).
TextBeforeIfFieldNotBlank	Specifies the text added to the SnapText before the content obtained from the bound data field (if this content is not empty).
TextFormat	Gets or sets format of the text obtained as the field result.

Name	Description
BeginUpdate()	Enables runtime customization of a SnapEntity. Inherited from SnapEntity.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Inherited from IDisposable.
EndUpdate()	Unlocks the SnapEntity after a call to the SnapEntity.BeginUpdate method and causes an immediate visual update of the object. Inherited from SnapEntity.

See Also

SnapText Interface

DevExpress.Snap.Core.API Namespace

Was this page helpful?

Thanks for your feedback!

How can we improve this help topic?

Add an example/code snippet.

Improve topic clarity.

Improve organization/make it easier to find.

Include additional information/content.

Additional comments/thoughts:

If you have any questions, submit a ticket to our Support Center.

No

Your feedback is appreciated.