Documents for PDF .NET Edition
GrapeCity.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.Spec Namespace / IPdfDictHolderExt Class / TryGetRefArray Method
The current PDF dictionary holder.
The key of the value to get.
OUT: the value associated with the specified key.
Specifies whether a single value should be converted to an array.

In This Topic
    TryGetRefArray Method
    In This Topic
    Tries to get the array of PdfRef structures associated with the specified key. Optionally converts a single PDF reference value to an array.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to an array of PdfRef structures.

    Syntax
    'Declaration
     
    Public Shared Function TryGetRefArray( _
       ByVal pdh As IPdfDictHolder, _
       ByVal key As System.String, _
       ByRef value() As PdfRef, _
       Optional ByVal singleToArray As System.Boolean _
    ) As System.Boolean
    public static System.bool TryGetRefArray( 
       IPdfDictHolder pdh,
       System.string key,
       out PdfRef[] value,
       System.bool singleToArray
    )

    Parameters

    pdh
    The current PDF dictionary holder.
    key
    The key of the value to get.
    value
    OUT: the value associated with the specified key.
    singleToArray
    Specifies whether a single value should be converted to an array.

    Return Value

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