Documents for PDF .NET Edition
GrapeCity.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.Spec Namespace / IPdfDictHolderExt Class
Methods

In This Topic
    IPdfDictHolderExt Class Members
    In This Topic

    The following tables list the members exposed by IPdfDictHolderExt.

    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)Clears the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Copies from the current dictionary to dest properties specified in propNames.

    dest can be null, in that case it will be initialized if there are any properties to copy.

     
    Public Methodstatic (Shared in Visual Basic)Copies from the current dictionary to dest all properties except those specified in propsToExclude.

    dest can be null, in that case it will be initialized if there are any properties to copy.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the IPdfArrayHolder object associated with the specified key.

    Throws an exception if the value does not exist or cannot be converted to IPdfArrayHolder.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the Boolean value associated with the specified key.

    Throws an exception if the value does not exist or cannot be converted to a Boolean.

     
    Public Methodstatic (Shared in Visual Basic)Gets the Boolean array associated with the specified key (in a PDF a Boolean array should be represented as a PDF array containing Booleans). Optionally converts a single Boolean value to an array.

    Throws an exception if the value does not exist or cannot be converted to a Boolean array.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the System.Drawing.Color associated with the specified key (in a PDF a System.Drawing.Color should be represented as an array of 1, 3 or 4 floats).

    Gets defValue if the value does not exist or cannot be converted to a System.Drawing.Color.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value cannot be converted to a System.Drawing.Color.  
    Public Methodstatic (Shared in Visual Basic)Gets the GrapeCity.Documents.Pdf.PdfDateTime object associated with the specified key (in a PDF a GrapeCity.Documents.Pdf.PdfDateTime should be represented as a PDF string).

    Gets defValue if the value does not exist or cannot be converted to a GrapeCity.Documents.Pdf.PdfDateTime.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value cannot be converted to a GrapeCity.Documents.Pdf.PdfDateTime.  
    Public Methodstatic (Shared in Visual Basic)Gets the RGB System.Drawing.Color associated with the specified key (in a PDF an RGB System.Drawing.Color should be represented as an array of 3 floats).

    Gets defValue if the value does not exist or cannot be converted to a System.Drawing.Color.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value cannot be converted to a System.Drawing.Color.  
    Public Methodstatic (Shared in Visual Basic)Gets the IPdfDictHolder object associated with the specified key.

    Gets defValue if the value does not exist or cannot be converted to IPdfDictHolder.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to IPdfDictHolder.  
    Public Methodstatic (Shared in Visual Basic)Gets the array of IPdfDictHolder objects associated with the specified key. Optionally converts a single IPdfDictHolder to an array.

    Throws an exception if the value does not exist or cannot be converted to a IPdfDictHolder array.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the enum value associated with the specified key (in a PDF enum values should be represented by PDF names).

    Gets defValue if the value does not exist or cannot be converted to T.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to T.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the float value associated with the specified key.

    Throws an exception if the value does not exist or cannot be converted to a float.

     
    Public Methodstatic (Shared in Visual Basic)Gets the float array associated with the specified key (in a PDF a float array should be represented as a PDF array containing floats). Optionally converts a single float value to an array.

    Throws an exception if the value does not exist or cannot be converted to a float array.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the integer value associated with the specified key.

    Throws an exception if the value does not exist or cannot be converted to an integer.

     
    Public Methodstatic (Shared in Visual Basic)Gets the integer array associated with the specified key (in a PDF an integer array should be represented as a PDF array containing integers). Optionally converts a single integer value to an array.

    Throws an exception if the value does not exist or cannot be converted to an integer array.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the GrapeCity.Documents.Pdf.PdfLang object associated with the specified key (in the PDF the PdfLang object should be represented as a PDF string).

    Throws an exception if the value does not exist or cannot be converted to GrapeCity.Documents.Pdf.PdfLang.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the System.Numerics.Matrix3x2 associated with the specified key (in a PDF a System.Numerics.Matrix3x2 should be represented as an array of 6 floats).

    Gets defValue if the value does not exist or cannot be converted to a System.Numerics.Matrix3x2.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value cannot be converted to a System.Numerics.Matrix3x2.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the PDF name value associated with the specified key.

    Throws an exception if the value does not exist or cannot be converted to a PDF name.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the array of strings associated with the specified key (in a PDF an array of strings should be represented as a PDF array containing PDF names). Optionally converts a single PDF name to an array.

    Throws an exception if the value does not exist or cannot be converted to an array of strings.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the GrapeCity.Documents.Common.Offsets associated with the specified key (in a PDF a GrapeCity.Documents.Common.Offsets should be represented as an array of 4 floats).

    Gets defValue if the value does not exist or cannot be converted to an GrapeCity.Documents.Common.Offsets.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value cannot be converted to an GrapeCity.Documents.Common.Offsets.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the GrapeCity.Documents.Pdf.PdfEnum<TEnum> struct associated with the specified key (in a PDF an GrapeCity.Documents.Pdf.PdfEnum<TEnum> struct should be represented by a PDF name).

    Gets defValue if the value does not exist or cannot be converted to GrapeCity.Documents.Pdf.PdfEnum<TEnum>.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to GrapeCity.Documents.Pdf.PdfEnum<TEnum>.  
    Public Methodstatic (Shared in Visual Basic)Gets the PdfString object associated with the specified key.

    Gets defValue if the value does not exist or cannot be converted to a PdfString.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a PdfString.  
    Public Methodstatic (Shared in Visual Basic)Gets the array associated with the specified key, resolving any references to indirect PDF objects. Optionally converts a single value to an array.

    Throws an exception if the value does not exists.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the System.Drawing.RectangleF associated with the specified key (in a PDF a System.Drawing.RectangleF should be represented as an array of 4 floats).

    Gets defValue if the value does not exist or cannot be converted to a System.Drawing.RectangleF.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value cannot be converted to a System.Drawing.RectangleF.  
    Public Methodstatic (Shared in Visual Basic)Gets the array of PdfRef structures associated with the specified key. Optionally converts a single value to an array.

    Throws an exception if the value does not exist or cannot be converted to an array of PdfRef structures.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the PdfString object associated with the specified key.

    Throws an exception if the value does not exist or cannot be converted to PdfString.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the string associated with the specified key. The string can be specified in the PDF as a PDF string or a PDF name.

    Throws an exception if the value does not exist or cannot be converted to a string.

     
    Public Methodstatic (Shared in Visual Basic)Sets the IPdfArrayHolder object associated with the specified key, removes a value if value is null.  
    Public Methodstatic (Shared in Visual Basic)Sets a Boolean value associated with the specified key, or removes the existing key if value is equal to defValue.  
    Public Methodstatic (Shared in Visual Basic)Sets a float value associated with the specified key, or removes the existing key if value is equal to defValue.  
    Public Methodstatic (Shared in Visual Basic)Sets an integer value associated with the specified key, or removes the existing key if value is equal to defValue.  
    Public Methodstatic (Shared in Visual Basic)Sets or removes the PDF name value associated with a specified key.

    If the specified value is equal to defValue, the value is removed from the current dictionary. Otherwise (if it is different from the default), the value is set.

     
    Public Methodstatic (Shared in Visual Basic)Sets or removes the PDF name array associated with a specified key.

    If the specified value is a null reference (Nothing in Visual Basic), the value is removed from the current dictionary. Otherwise the value is set.

     
    Public Methodstatic (Shared in Visual Basic)Sets or removes the PDF name value associated with a specified key.

    If the specified value is a null reference (Nothing in Visual Basic) or empty, the value is removed from the current dictionary. Otherwise the value is set.

     
    Public Methodstatic (Shared in Visual Basic)Sets a PdfString value associated with the specified key, or removes the existing key if value is null or empty.  
    Public Methodstatic (Shared in Visual Basic)Sets a value with specified key, the value will be removed from dictionary if value equals to defValue.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the IPdfArrayHolder object associated with the specified key.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to IPdfArrayHolder.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the Boolean value associated with the specified key.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a Boolean.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the Boolean array associated with the specified key (in a PDF a Boolean array should be represented as a PDF array containing Booleans). Optionally converts a single Boolean value to an array.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a Boolean array.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the System.Drawing.Color associated with the specified key (in a PDF a System.Drawing.Color should be represented as an array of 1, 3 or 4 floats).

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to System.Drawing.Color.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the GrapeCity.Documents.Pdf.PdfDateTime object associated with the specified key (in a PDF a GrapeCity.Documents.Pdf.PdfDateTime should be represented as a PDF string).

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to GrapeCity.Documents.Pdf.PdfDateTime.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the RGB System.Drawing.Color associated with the specified key (in a PDF an RGB System.Drawing.Color should be represented as an array of 3 floats).

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to System.Drawing.Color.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the IPdfDictHolder object associated with the specified key.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a IPdfDictHolder.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the array of IPdfDictHolder objects associated with the specified key. Optionally converts a single IPdfDictHolder to an array.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a IPdfDictHolder array.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the enum value associated with the specified key.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to T.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the float value associated with the specified key.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a float.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the float array associated with the specified key (in a PDF a float array should be represented as a PDF array containing floats). Optionally converts a single float value to an array.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a float array.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the integer value associated with the specified key.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to an integer.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the integer array associated with the specified key (in a PDF an integer array should be represented as a PDF array containing integers). Optionally converts a single integer value to an array.

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

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the System.Numerics.Matrix3x2 associated with the specified key (in a PDF a System.Numerics.Matrix3x2 should be represented as an array of 6 floats).

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to System.Numerics.Matrix3x2.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the PDF name value 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 PDF name.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the array of strings associated with the specified key (in a PDF an array of strings should be represented as a PDF array containing PDF names). Optionally converts a single PDF name to an array.

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

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the GrapeCity.Documents.Common.Offsets associated with the specified key (in a PDF an GrapeCity.Documents.Common.Offsets should be represented as an array of 4 floats).

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to GrapeCity.Documents.Common.Offsets.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the GrapeCity.Documents.Pdf.PdfEnum<TEnum> struct associated with the specified key.

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to GrapeCity.Documents.Pdf.PdfEnum<TEnum>.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the value associated with the specified key. If the value is a reference to an indirect PDF object, resolves the reference and gets the value of the indirect object.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the array associated with the specified key, resolving any references to indirect PDF objects. Optionally converts a single value to an array.

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

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the System.Drawing.RectangleF associated with the specified key (in a PDF a System.Drawing.RectangleF should be represented as an array of 4 floats).

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to System.Drawing.RectangleF.

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the PdfRef associated with the specified key. Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a PdfRef.  
    Public Methodstatic (Shared in Visual Basic)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.

     
    Public Methodstatic (Shared in Visual Basic)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.

     
    Public Methodstatic (Shared in Visual Basic)Overloaded. Tries to get the array of PdfString objects associated with the specified key (in a PDF a PdfString array should be represented as a PDF array containing PDF strings). Optionally converts a single PDF string to an array.

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

     
    Public Methodstatic (Shared in Visual Basic)Tries to get the string associated with the specified key. The string can be specified in the PDF as a PDF string or a PDF name.

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

     
    Public Methodstatic (Shared in Visual Basic)Gets the value associated with the specified key.  
    Top
    See Also