Documents for PDF .NET Edition
GrapeCity.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.Spec Namespace / IPdfDictHolderExt Class / TryGetString Method
The current PDF dictionary holder.
The key of the value to get.
OUT: the value associated with the specified key.
Specifies whether to add a warning if the value could not be converted.

In This Topic
    TryGetString Method (IPdfDictHolderExt)
    In This Topic
    Tries to get the PdfString object associated with the specified key.

    Optionally adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a PdfString.

    Syntax
    'Declaration
     
    Public Shared Function TryGetString( _
       ByVal pdh As IPdfDictHolder, _
       ByVal key As System.String, _
       ByRef value As PdfString, _
       Optional ByVal addWarning As System.Boolean _
    ) As System.Boolean
    public static System.bool TryGetString( 
       IPdfDictHolder pdh,
       System.string key,
       out PdfString value,
       System.bool addWarning
    )

    Parameters

    pdh
    The current PDF dictionary holder.
    key
    The key of the value to get.
    value
    OUT: the value associated with the specified key.
    addWarning
    Specifies whether to add a warning if the value could not be converted.

    Return Value

    True if the key was found and the value could be converted to a PdfString, false otherwise.
    See Also