OffsetFromLocation Method

Returns the corresponding overall zero-based offset from a line and character location.

Syntax

Visual Basic

'Declaration
 
Public Function OffsetFromLocation( _
   ByVal location As TextLocation _
) As Integer

C#

public int OffsetFromLocation( 
   TextLocation location
)

Parameters

location

The zero-based line and character numbers for a character location in this snapshot.

Return Value

The corresponding overall zero-based offset from the beginning of the document..

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	If resulting offset is less than zero or greater than the document's overall length - 1.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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