DocumentWord Structure

Contains the properties of a text word found in the document.

Object Model

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

[SerializableAttribute()]
public struct DocumentWord : System.ValueType

'Declaration
 
<SerializableAttribute()>
Public Structure DocumentWord 
   Inherits System.ValueType

'Usage
 
Dim instance As DocumentWord

[SerializableAttribute()]
public class DocumentWord

JAVASCRIPT_NOSTRUCTS

[SerializableAttribute()]
public value class DocumentWord : public System.ValueType

Remarks

The DocumentWord structure is used as the type for the DocumentPageText.Words list.

Read the text of a document page by using the DocumentObjectManager.ParsePageText method. The text characters found in the page will be set in the in DocumentPageText.Characters property of the returned DocumentPageText object.

The text words are created from the characters found in the document based on the DocumentCharacter.IsEndOfWord returned by the document reader engine. Whenever an "end of word" is found, the last set of characters are grouped together and stored as an item in the DocumentPageText.Words list.

The overall text string (without any extra properties) can be obtained using the DocumentPageText.BuildText method.

Example

For an example, refer to DocumentPageText.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DocumentWord Members
Leadtools.Forms.DocumentReaders Namespace