Document Solutions for PDF
DS.Documents.Pdf Assembly / GrapeCity.Documents.Pdf.Spec Namespace / IPdfDictExt Class
Methods

In This Topic
    IPdfDictExt Class Members
    In This Topic

    The following tables list the members exposed by IPdfDictExt.

    Public Methods
     NameDescription
    Public Methodstatic (Shared in Visual Basic)Clears the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Determines whether this IPdfDict contains the specified key.  
    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)Gets the count of items in the IPdfDict.  
    Public Methodstatic (Shared in Visual Basic)Converts the IPdfDict to a string.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the value associated with the specified key, if the value does not exist or cannot be converted to a T returns a null reference (Nothing in Visual Basic). Note! This method returns IPdfRef if T is IPdfRef, otherwise the method resolves the reference and returns *actual* object.  
    Public Methodstatic (Shared in Visual Basic)Gets the array of T objects associated with the specified key. Returns null if the array does not exist or cannot be converted to an array of T.  
    Public Methodstatic (Shared in Visual Basic)Gets the value at the specified path. The path can contain IPdfName objects which are interpreted as dictionary keys, or integers which are interpreted as IPdfArray indices.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the Boolean value associated with the specified key. If the value does not exist or cannot be converted to a Boolean, returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Gets the Boolean array associated with the specified key. Returns null if the array 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 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 IPdfDict array associated with the specified key. Returns null if the array does not exist or cannot be converted to an IPdfDict array.  
    Public Methodstatic (Shared in Visual Basic)Gets the nullable Double value associated with the specified key. If the value does not exist or cannot be converted to a Double, returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the nullable enum value associated with the specified key. If the value does not exist or cannot be converted to an enum, returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the nullable Float value associated with the specified key. If the value does not exist or cannot be converted to a Float, returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Gets the float array associated with the specified key. Returns null if the array 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. If the value does not exist or cannot be converted to an Integer, returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Gets the Integer array associated with the specified key. Returns null if the array does not exist or cannot be converted to an Integer array.  
    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)Gets the PDF Name value associated with the specified key. If the value does not exist or cannot be converted to a PDF Name, returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Gets the PdfName array associated with the specified key. Returns null if the array does not exist or cannot be converted to a PdfName array.  
    Public Methodstatic (Shared in Visual Basic)Gets the PDF Name array associated with the specified key. Returns null if the array does not exist or cannot be converted to a PDF Name array.  
    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)Gets the GrapeCity.Documents.Pdf.PdfDateTime value associated with the specified key. If the value does not exist or cannot be converted to a GrapeCity.Documents.Pdf.PdfDateTime, returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Gets the nullable GrapeCity.Documents.Pdf.PdfEnum<TEnum> value associated with the specified key. If the value does not exist returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Gets the bytes of the IPdfString associated with the specified key. If the value does not exist or cannot be converted to an IPdfString, returns a null reference (Nothing in Visual Basic).  
    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 IPdfRef objects associated with the specified key, Returns null if the array does not exist or cannot be converted to an array of IPdfRef.  
    Public Methodstatic (Shared in Visual Basic)Returns the decoded stream data if IPdfDict is a PdfStreamObjectBase.  
    Public Methodstatic (Shared in Visual Basic)Gets the String value associated with the specified key. If the value does not exist or cannot be converted to a String, returns defValue (which can be null).  
    Public Methodstatic (Shared in Visual Basic)Gets the String array associated with the specified key. Returns null if the array does not exist or cannot be converted to a String array.  
    Public Methodstatic (Shared in Visual Basic)Gets the string associated with the specified key. The string can be specified in the PDF as a PDF string or a PDF name.

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

    Adds a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if the value exists but cannot be converted to a string.  
    Public Methodstatic (Shared in Visual Basic)Removes the value associated with the specified key.  
    Public Methodstatic (Shared in Visual Basic)Removes all entries related to the stream: Length, Filter, DecodeParms. The method does not change the IPdfDict.Changed flag.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Sets the value associated with the specified key. If value is a null reference (Nothing in Visual Basic), the entry specified by the key will be removed.  
    Public Methodstatic (Shared in Visual Basic)Sets the Boolean value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the Color value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the RGB System.Drawing.Color value associated with the specified key (in a PDF an RGB System.Drawing.Color should be represented as an array of 3 floats).  
    Public Methodstatic (Shared in Visual Basic)Sets the Double value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the float value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the float array associated with the specified key. If the value is null, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the Integer value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the int array associated with the specified key. If the value is null, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the System.Numerics.Matrix3x2 value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the PDF Name value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary. Note! The method converts a System.String to the PdfName.  
    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 the PDF Name value associated with the specified key. If the value is null or empty, removes the key from the dictionary. Note! The method converts a System.String to the PdfName.  
    Public Methodstatic (Shared in Visual Basic)Sets the GrapeCity.Documents.Common.Offsets value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the GrapeCity.Documents.Pdf.PdfDateTime value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the nullable GrapeCity.Documents.Pdf.PdfEnum<TEnum> value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary. Note! The method converts a GrapeCity.Documents.Pdf.PdfEnum<TEnum> to the PdfName.  
    Public Methodstatic (Shared in Visual Basic)Sets the IPdfString associated with the specified key to the specified value. If the value is a null reference (Nothing in Visual Basic), removes the key from the dictionary. Returns the created PdfString.  
    Public Methodstatic (Shared in Visual Basic)Sets the System.Drawing.RectangleF value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary.  
    Public Methodstatic (Shared in Visual Basic)Sets the String value representing the Rich Text associated with the specified key. If the value is null or empty removes the key from the dictionary. Note! The method converts a System.String to the PdfString. Note! The method encloses the value with PdfConsts.c_RichStringPrefix and PdfConsts.c_RichStringSuffix  
    Public Methodstatic (Shared in Visual Basic)Sets the value associated with the specified key without affecting the IPdfDict.Changed value. If value is a null reference (Nothing in Visual Basic), the entry specified by the key will be removed.  
    Public Methodstatic (Shared in Visual Basic)Sets the String value associated with the specified key. If the value is null or is equal to defValue, removes the key from the dictionary. Note! The method converts a System.String to the PdfString.  
    Public Methodstatic (Shared in Visual Basic)Sets or removes the PDF string 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 the String value associated with the specified key. If the value is null or empty removes the key from the dictionary. Note! The method converts a System.String to the PdfString.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Tries to get the value associated with the specified key, Returns true if value exists and can be converted to a T, resolves a PDF reference if needed. Note! The method does not resolve reference if T is IPdfRef, otherwise the method resolves the reference and returns *actual* object.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Tries to gets the array of T objects associated with the specified key.  
    Public Methodstatic (Shared in Visual Basic)Gets the value at the specified path. The path can contain IPdfName objects which are interpreted as dictionary keys, or integers which are interpreted as IPdfArray indices.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the Boolean value associated with the specified key. If the value does not exist or cannot be converted to a Boolean, returns false.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the bool array associated with the specified key.  
    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 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 gets the array of IPdfDict objects associated with the specified key.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the Double value associated with the specified key. If the value does not exist or cannot be converted to a Double, returns false.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the enum value associated with the specified key. If the value does not exist or cannot be converted to an enum, returns false.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the Float value associated with the specified key. If the value does not exist or cannot be converted to a Float, returns false.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the float array associated with the specified key.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the Integer value associated with the specified key. If the value does not exist or cannot be converted to an Integer, returns false.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the Integer array associated with the specified key.  
    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. If the value does not exist or cannot be converted to a PDF Name, returns false.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the PDF Name array associated with the specified key.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the PDF Name array associated with the specified key, the PDF names converted to 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.PdfDateTime value associated with the specified key. If the value does not exist or cannot be converted to the GrapeCity.Documents.Pdf.PdfDateTime, returns false.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the GrapeCity.Documents.Pdf.PdfEnum<TEnum> value associated with the specified key. If the value does not exist or cannot be converted to an enum, returns false.  
    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 gets the array of IPdfRef objects associated with the specified key.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the String value associated with the specified key. If the value does not exist or cannot be converted to a String, returns false.  
    Public Methodstatic (Shared in Visual Basic)Tries to get the string array associated with the specified key.  
    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)Tries to get a value with specified key. The method does not perform any processing of the value and returns it as is.  
    Top
    See Also