Reference Guide
GdPicture14.WPF Namespace / GdViewer Class / GetTextOccurrenceCount Method / GetTextOccurrenceCount(Int32,String,Boolean,Boolean) Method
The page number of the page to search for text.
The text expression to search for.
Set this parameter to true if you want to apply case-sensitive search, otherwise set it to false.
Set this parameter to true if you want to search for the whole words only, otherwise set it to false.
Example





In This Topic
    GetTextOccurrenceCount(Int32,String,Boolean,Boolean) Method
    In This Topic
    Searches for an occurrence of a given text expression within the specified page of the document displayed in the GdViewer control according to the parameters you have specified. If the format of the displayed document is other than supported text-based formats, which currently are DOCX, TXT, RTF and PDF, this method will fail.

    Please note that this method uses InvariantCulture comparison when searching. It means, that characters are comparing using culture-sensitive sort rules and the invariant culture, in other words this method respects accents when searching.

    Syntax
    'Declaration
     
    
    Public Overloads Function GetTextOccurrenceCount( _
       ByVal Page As Integer, _
       ByVal Text As String, _
       ByVal CaseSensitive As Boolean, _
       ByVal WholeWords As Boolean _
    ) As Integer
    public int GetTextOccurrenceCount( 
       int Page,
       string Text,
       bool CaseSensitive,
       bool WholeWords
    )
    public function GetTextOccurrenceCount( 
        Page: Integer;
        Text: String;
        CaseSensitive: Boolean;
        WholeWords: Boolean
    ): Integer; 
    public function GetTextOccurrenceCount( 
       Page : int,
       Text : String,
       CaseSensitive : boolean,
       WholeWords : boolean
    ) : int;
    public: int GetTextOccurrenceCount( 
       int Page,
       string* Text,
       bool CaseSensitive,
       bool WholeWords
    ) 
    public:
    int GetTextOccurrenceCount( 
       int Page,
       String^ Text,
       bool CaseSensitive,
       bool WholeWords
    ) 

    Parameters

    Page
    The page number of the page to search for text.
    Text
    The text expression to search for.
    CaseSensitive
    Set this parameter to true if you want to apply case-sensitive search, otherwise set it to false.
    WholeWords
    Set this parameter to true if you want to search for the whole words only, otherwise set it to false.

    Return Value

    The number of occurrences if the given text expression has been found on the current page according to the specified parameters. Please always use the GetStat method to determine if this method has been successful.
    Remarks
    Please note that this method is only useful for text-based document formats, like DOCX, TXT, RTF and PDF.

    Be aware that this method respects accents when searching. You can use the overloaded GetTextOccurrenceCount(Int32,String,Boolean,Boolean,Boolean) method for searching not respecting accents.

    Example
    How to search for the specified text applying the InvariantCulture comparison.
    'We assume that the GdViewer1 control has been properly integrated
    'and your document has been properly displayed as well.
    Sub MySearchText(ByVal TextToSearch As String)
        Dim page As Integer = 1, occurrence As Integer = 0
        Dim status As GdPictureStatus = GdPictureStatus.OK
        While (status = GdPictureStatus.OK) AndAlso (page <= GdViewer1.PageCount)
            occurrence = GdViewer1.GetTextOccurrenceCount(page, TextToSearch, False, False)
            status = GdViewer1.GetStat()
            If status = GdPictureStatus.OK Then
                If occurrence > 0 Then Exit While
                page += 1
            End If
        End While
        If (status = GdPictureStatus.OK) AndAlso (occurrence > 0) Then GdViewer1.DisplayPage(page)
    End Sub
    //We assume that the GdViewer1 control has been properly integrated
    //and your document has been properly displayed as well.
    void MySearchText(string TextToSearch)
    {
        int page = 1, occurrence = 0;
        GdPictureStatus status = GdPictureStatus.OK;
        while ((status == GdPictureStatus.OK) && (page <= GdViewer1.PageCount))
        {
            occurrence = GdViewer1.GetTextOccurrenceCount(page, TextToSearch, false, false);
            status = GdViewer1.GetStat();
            if (status == GdPictureStatus.OK)
            {
                if (occurrence > 0) break;
                page++;
            }
        }
        if ((status == GdPictureStatus.OK) && (occurrence > 0))
            GdViewer1.DisplayPage(page);
    }
    See Also