Name | Description | |
---|---|---|
![]() ![]() | Clear | Clears the dictionary. |
![]() ![]() | ContainsKey | Determines whether this IPdfDict contains the specified key. |
![]() ![]() | CopyToExcluding | Copies from the current dictionary to dest all properties except those specified in propsToExclude.
dest can be |
![]() ![]() | Count | Gets the count of items in the IPdfDict. |
![]() ![]() | DictToString | Converts the IPdfDict to a string. |
![]() ![]() | Get | 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. |
![]() ![]() | GetArray<T> | 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. |
![]() ![]() | GetAtPath<T> | 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. |
![]() ![]() | GetBool | 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). |
![]() ![]() | GetBoolArray | 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. |
![]() ![]() | GetColor | 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. |
![]() ![]() | GetDeviceRGBColor | 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. |
![]() ![]() | GetDictArray | 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. |
![]() ![]() | GetDouble | 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). |
![]() ![]() | GetEnum | 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). |
![]() ![]() | GetFloat | 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). |
![]() ![]() | GetFloatArray | 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. |
![]() ![]() | GetInt | 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). |
![]() ![]() | GetIntArray | 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. |
![]() ![]() | GetMatrix | 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. |
![]() ![]() | GetName | 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). |
![]() ![]() | GetNameArray | 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. |
![]() ![]() | GetNameArrayStr | 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. |
![]() ![]() | GetOffsets | 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. |
![]() ![]() | GetPdfDateTime | 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). |
![]() ![]() | GetPdfEnum | 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). |
![]() ![]() | GetPdfStringBytes | 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). |
![]() ![]() | GetRect | 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. |
![]() ![]() | GetRefArray | 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. |
![]() ![]() | GetStreamData | Returns the decoded stream data if IPdfDict is a PdfStreamObjectBase. |
![]() ![]() | GetString | 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). |
![]() ![]() | GetStringArray | 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. |
![]() ![]() | GetStringOrName | 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. |
![]() ![]() | Remove | Removes the value associated with the specified key. |
![]() ![]() | RemoveStreamEntries | Removes all entries related to the stream: Length, Filter, DecodeParms. The method does not change the IPdfDict.Changed flag. |
![]() ![]() | Set | 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. |
![]() ![]() | SetBool | 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. |
![]() ![]() | SetColor | 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. |
![]() ![]() | SetDeviceRGBColor | 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). |
![]() ![]() | SetDouble | 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. |
![]() ![]() | SetFloat | 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. |
![]() ![]() | SetFloatArray | Sets the float array associated with the specified key. If the value is null, removes the key from the dictionary. |
![]() ![]() | SetInt | 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. |
![]() ![]() | SetIntArray | Sets the int array associated with the specified key. If the value is null, removes the key from the dictionary. |
![]() ![]() | SetMatrix | 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. |
![]() ![]() | SetName | 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. |
![]() ![]() | SetNameArray | 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. |
![]() ![]() | SetNameNotEmpty | 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. |
![]() ![]() | SetOffsets | 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. |
![]() ![]() | SetPdfDateTime | 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. |
![]() ![]() | SetPdfEnum<T> | 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. |
![]() ![]() | SetPdfStringBytes | 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. |
![]() ![]() | SetRect | 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. |
![]() ![]() | SetRichTextNotEmpty | 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 |
![]() ![]() | SetSilent | 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. |
![]() ![]() | SetString | 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. |
![]() ![]() | SetStringArray | 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. |
![]() ![]() | SetStringNotEmpty | 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. |
![]() ![]() | TryGet | 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. |
![]() ![]() | TryGetArray | Overloaded. Tries to gets the array of T objects associated with the specified key. |
![]() ![]() | TryGetAtPath<T> | 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. |
![]() ![]() | TryGetBool | 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. |
![]() ![]() | TryGetBoolArray | Tries to get the bool array associated with the specified key. |
![]() ![]() | TryGetColor | 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. |
![]() ![]() | TryGetDeviceRGBColor | 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. |
![]() ![]() | TryGetDictArray | Tries to gets the array of IPdfDict objects associated with the specified key. |
![]() ![]() | TryGetDouble | 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. |
![]() ![]() | TryGetEnum<T> | 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. |
![]() ![]() | TryGetFloat | 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. |
![]() ![]() | TryGetFloatArray | Tries to get the float array associated with the specified key. |
![]() ![]() | TryGetInt | 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. |
![]() ![]() | TryGetIntArray | Tries to get the Integer array associated with the specified key. |
![]() ![]() | TryGetMatrix | 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. |
![]() ![]() | TryGetName | 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. |
![]() ![]() | TryGetNameArray | Tries to get the PDF Name array associated with the specified key. |
![]() ![]() | TryGetNameArrayStr | Tries to get the PDF Name array associated with the specified key, the PDF names converted to strings. |
![]() ![]() | TryGetOffsets | 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. |
![]() ![]() | TryGetPdfDateTime | 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. |
![]() ![]() | TryGetPdfEnum<T> | 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. |
![]() ![]() | TryGetRect | 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. |
![]() ![]() | TryGetRefArray | Tries to gets the array of IPdfRef objects associated with the specified key. |
![]() ![]() | TryGetString | 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. |
![]() ![]() | TryGetStringArray | Tries to get the string array associated with the specified key. |
![]() ![]() | TryGetStringOrName | 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. |
![]() ![]() | TryGetValue | Tries to get a value with specified key. The method does not perform any processing of the value and returns it as is. |