FirstCharacterIndex Property

Gets or sets the index of the first character that forms this word value in the DocumentPageText.Characters list.

[DataMemberAttribute(Name="firstCharacterIndex", Order=9)] 
public int FirstCharacterIndex { get; set; } 

  
Public Property FirstCharacterIndex As Integer 

public: 
property int FirstCharacterIndex { 
   int get(); 
   void set (    int ); 
} 

Property Value

A System.Int32 that specifies the index of first character that forms this word value in the DocumentPageText.Characters list. The default value is 0.

The text of a document page is read 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 index of the first and last character of each word found into the DocumentPageText.Characters list are stored in the FirstCharacterIndex and LastCharacterIndex properties.

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

For an example, refer to DocumentPageText.

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 Structure

DocumentWord Members