PowerTCP Emulation for .NET CF
ScrapeText Method
See Also  Send comments on this topic.
Dart.Emulation Namespace > Vt Class : ScrapeText Method




start
Column/row of first cell, 0-relative, inclusive.
end
Column/row of last cell, 0-relative, inclusive.
mode
The SelectionMode to use.
Retrieves text (minus escape characters) from the Vt display.

Syntax

Visual Basic (Declaration) 
Public Function ScrapeText( _
   ByVal start As Point, _
   ByVal end As Point, _
   ByVal mode As SelectionMode _
) As String
Visual Basic (Usage)Copy Code
Dim instance As Vt
Dim start As Point
Dim end As Point
Dim mode As SelectionMode
Dim value As String
 
value = instance.ScrapeText(start, end, mode)
C# 
public string ScrapeText( 
   Point start,
   Point end,
   SelectionMode mode
)
Managed Extensions for C++ 
public: string* ScrapeText( 
   Point start,
   Point end,
   SelectionMode mode
) 
C++/CLI 
public:
String^ ScrapeText( 
   Point start,
   Point end,
   SelectionMode mode
) 

Parameters

start
Column/row of first cell, 0-relative, inclusive.
end
Column/row of last cell, 0-relative, inclusive.
mode
The SelectionMode to use.

Return Value

A string representation of the scraped characters.

Remarks

This method retrieves all of the text between the specifed Points, removing all escape characters. An empty string is returned if no cells are selected.

Note that the row values are relative to the start of the scrollback buffer. A CrLf pair separates each row.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

Documentation Version 4.2
© 2010 Dart Communications. All Rights Reserved.