GdPicture.NET.14~GdPicture14.GdViewer~SelectAllText - SelectAllText Method (GdViewer) -

SelectAllText Method (GdViewer)

In This Topic

Selects all text on the currently displayed page of the text-based document in the GdViewer control. Be aware that text selection is only enabled if the GdViewer.EnableTextSelection property is set to true.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Function SelectAllText() As GdPictureStatus

public GdPictureStatus SelectAllText()

public function SelectAllText(): GdPictureStatus;

public function SelectAllText() : GdPictureStatus;

public: GdPictureStatus SelectAllText();

public:
GdPictureStatus SelectAllText();

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK. We strongly recommend always checking this status first.

Remarks

Please note that text selection is only enabled if the GdViewer.EnableTextSelection property is set to true, otherwise the method will fail.

Example

How to select all text on the currently displayed page in the viewer, how to extract it and how to clear the selection.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
If GdViewer1.DisplayFromFile("") = GdPictureStatus.OK Then
    'Enabling text selection.
    GdViewer1.EnableTextSelection = True
    If GdViewer1.SelectAllText() = GdPictureStatus.OK Then
        Dim selected_text As String = GdViewer1.GetSelectedText()
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            'Do your stuff with the page_text.
            GdViewer1.ClearSelectedText()
        Else
            MessageBox.Show("The text can't be extracted. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SelectAllText")
        End If
    Else
        MessageBox.Show("The text can't be selected. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SelectAllText")
    End If
Else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SelectAllText")
End If

//We assume that the GdViewer1 control has been properly integrated.
if (GdViewer1.DisplayFromFile("") == GdPictureStatus.OK)
{
    //Enabling text selection.
    GdViewer1.EnableTextSelection = true;
    if (GdViewer1.SelectAllText() == GdPictureStatus.OK)
    {
        string selected_text = GdViewer1.GetSelectedText();
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
        {
            //Do your stuff with the selected_text.
            GdViewer1.ClearSelectedText();
        }
        else
            MessageBox.Show("The text can't be extracted. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SelectAllText");
    }
    else
        MessageBox.Show("The text can't be selected. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SelectAllText");
}
else
    MessageBox.Show("The file can't be displayed. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.SelectAllText");

Reference

GdViewer Class
GdViewer Members
EnableTextSelection Property
GetSelectedText Method
ClearSelectedText Method
SearchText Method