Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
Public Member Functions | Static Public Member Functions | Properties | List of all members
SolidFramework.Pdf.Plumbing.PdfStreamObject Class Reference

Represents PDF stream object More...

Inheritance diagram for SolidFramework.Pdf.Plumbing.PdfStreamObject:
SolidFramework.Pdf.Plumbing.PdfDictionary SolidFramework.Pdf.Plumbing.PdfItem

Public Member Functions

override void Dispose ()
 
 PdfStreamObject (SolidFramework.Pdf.PdfDocument pdfDocument)
 Initializes a new instance of the PdfStreamObject class.
 
string GetDataAsString ()
 Gets the data as string.
 
global::System.Drawing.Bitmap ToBitmap (SolidFramework.Pdf.PdfDocument document)
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 
SolidFramework.Pdf.Plumbing.PdfDictionaryItemsCollection GetPdfDictionaryItemsCollection ()
 
SolidFramework.Pdf.Plumbing.PdfItem GetDictionaryValueByIndex (int i)
 
bool TryGetValue (string key, out SolidFramework.Pdf.Plumbing.PdfItem value)
 Retrieves the value for the given key, if possible. More...
 
void Add (global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem > item)
 Adds an item containing a key and value to the T:System.Collections.Generic.IDictionary. More...
 
void Add (string key, SolidFramework.Pdf.Plumbing.PdfItem value)
 Adds an element with the provided key and value to the dictionary. More...
 
bool Remove (global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem > item)
 Removes the element with the specified key from the T:Dictionary. More...
 
bool Contains (global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem > item)
 Determines whether the T:Dictionary contains an element with the key specified in item. More...
 
void CopyTo (global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem >[] array)
 
void CopyTo (global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem >[] array, int arrayIndex)
 
bool ContainsKey (string key)
 Determines whether the dictionary contains an element with the specified key. More...
 
void Clear ()
 Removes all items from the dictionary.
 
bool ClearMetadata ()
 Clears the metadata. More...
 
global::System.IntPtr GetHandle ()
 
bool Equals (SolidFramework.Pdf.Plumbing.PdfItem other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static SolidFramework.Pdf.Plumbing.PdfItem GetIndirectionItem (SolidFramework.Pdf.Plumbing.PdfItem item)
 
static SolidFramework.Pdf.Plumbing.PdfItem GetIndirectionItem (SolidFramework.Pdf.Plumbing.PdfItem item, string forceType)
 
static SolidFramework.Pdf.Plumbing.PdfObject GetIndirectionObject (SolidFramework.Pdf.Plumbing.PdfItem item)
 
static bool operator== (SolidFramework.Pdf.Plumbing.PdfItem obj1, SolidFramework.Pdf.Plumbing.PdfItem obj2)
 
static bool operator!= (SolidFramework.Pdf.Plumbing.PdfItem obj1, SolidFramework.Pdf.Plumbing.PdfItem obj2)
 

Properties

global::System.Collections.ObjectModel.ReadOnlyCollection< byte > DataAsReadOnlyCollection [get]
 
global::System.IntPtr Data [get]
 Gets the data.
 
int Length [get]
 Gets the length.
 
int DataLength [get]
 Gets the data length.
 
bool IsReadOnly [get]
 Gets whether the collection is readonly. This method always returns false.
 
global::System.Collections.Generic.ICollection< string > Keys [get]
 Gets an T: System.Collections.ICollection containing the keys of the T: System.Collections.IDictionary. More...
 
global::System.Collections.Generic.ICollection< SolidFramework.Pdf.Plumbing.PdfItemValues [get]
 Gets an T:System.Collections.ICollection containing the values in the T:System.Collections.IDictionary. More...
 
SolidFramework.Pdf.Plumbing.PdfItem this[string key] [getset]
 
string Type [get]
 Gets the type.
 
int Count [get]
 Gets the number of elements contained in the dictionary. More...
 
SolidFramework.Pdf.Plumbing.PdfObjectType PdfObjectType [get]
 Gets the type of the PDF object. More...
 

Detailed Description

Represents PDF stream object

Member Function Documentation

◆ Add() [1/2]

void SolidFramework.Pdf.Plumbing.PdfDictionary.Add ( global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem item)
inherited

Adds an item containing a key and value to the T:System.Collections.Generic.IDictionary.

Parameters
itemA KeyValuePair that contains the key and value of the itme to be add.
Exceptions
T:System.ArgumentNullExceptionitem is null.

◆ Add() [2/2]

void SolidFramework.Pdf.Plumbing.PdfDictionary.Add ( string  key,
SolidFramework.Pdf.Plumbing.PdfItem  value 
)
inherited

Adds an element with the provided key and value to the dictionary.

Parameters
keyThe object to use as the key of the element to add.
valueThe object to use as the value of the element to add.

◆ ClearMetadata()

bool SolidFramework.Pdf.Plumbing.PdfDictionary.ClearMetadata ( )
inherited

Clears the metadata.

Returns

◆ Contains()

bool SolidFramework.Pdf.Plumbing.PdfDictionary.Contains ( global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem item)
inherited

Determines whether the T:Dictionary contains an element with the key specified in item.

Returns
true if the T:SDictionary contains an element with the key; otherwise, false.
Parameters
itemA KeyValuePair containing the key to locate in the T:Dictionary.
Exceptions
T:System.ArgumentNullExceptionitem is null.

summary> Copies all the elements of the dictionary to the specified one-dimensional array starting at the beginning /summary>

◆ ContainsKey()

bool SolidFramework.Pdf.Plumbing.PdfDictionary.ContainsKey ( string  key)
inherited

Determines whether the dictionary contains an element with the specified key.

Parameters
keyThe key to locate in the dictionary.
Returns
true if the dictionary contains an element with the key; otherwise false.

◆ CopyTo()

void SolidFramework.Pdf.Plumbing.PdfDictionary.CopyTo ( global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem >[]  array)
inherited

summary> Copies all the elements of the dictionary to the specified one-dimensional array starting at the specified destination array index. /summary>

◆ Dispose()

override void SolidFramework.Pdf.Plumbing.PdfStreamObject.Dispose ( )
virtual

◆ Remove()

bool SolidFramework.Pdf.Plumbing.PdfDictionary.Remove ( global::System.Collections.Generic.KeyValuePair< string, SolidFramework.Pdf.Plumbing.PdfItem item)
inherited

Removes the element with the specified key from the T:Dictionary.

Returns
true if the element is successfully removed; otherwise, false. This method also returns false if item was not found in the original T:Dictionary.
Parameters
itemPdfItem to be removed.
Exceptions
T:System.ArgumentNullExceptionitem is null.

◆ ToString()

override string SolidFramework.Pdf.Plumbing.PdfDictionary.ToString ( )
inherited

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.

◆ TryGetValue()

bool SolidFramework.Pdf.Plumbing.PdfDictionary.TryGetValue ( string  key,
out SolidFramework.Pdf.Plumbing.PdfItem  value 
)
inherited

Retrieves the value for the given key, if possible.

Returns
true if there is a value present for the specified key; otherwise, false.
Parameters
keyThe key associated with the value to retrieve.
valueThe value associated with the specified key.
Exceptions
T:System.ArgumentNullExceptionIf key is null.

Property Documentation

◆ Count

int SolidFramework.Pdf.Plumbing.PdfDictionary.Count
getinherited

Gets the number of elements contained in the dictionary.

Returns
The number of elements contained in the dictionary.

◆ Keys

global.System.Collections.Generic.ICollection<string> SolidFramework.Pdf.Plumbing.PdfDictionary.Keys
getinherited

Gets an T: System.Collections.ICollection containing the keys of the T: System.Collections.IDictionary.

Returns
An T:System.Collections.ICollection containing the keys of the T:System.Collections.IDictionary.

◆ PdfObjectType

SolidFramework.Pdf.Plumbing.PdfObjectType SolidFramework.Pdf.Plumbing.PdfItem.PdfObjectType
getinherited

Gets the type of the PDF object.

The type of the PDF object.

◆ Values

global.System.Collections.Generic.ICollection<SolidFramework.Pdf.Plumbing.PdfItem> SolidFramework.Pdf.Plumbing.PdfDictionary.Values
getinherited

Gets an T:System.Collections.ICollection containing the values in the T:System.Collections.IDictionary.

Returns
An T:System.Collections.ICollection containing the values in the T:System.Collections.IDictionary.