GrapeCity.Documents.Pdf.Spec.IPdfDictExt.TryGetArray

TryGetArray Method

TryGetArray<T>(IPdfDict, PdfName, out T[], bool, bool, bool)

Tries to gets the array of T objects associated with the specified key.

Declaration

public static bool TryGetArray<T>(IPdfDict dict, PdfName key, out T[] value, bool singleToArray, bool allowNulls, bool addWarning) where T : IPdfObject

Public Shared Function TryGetArray(Of T As IPdfObject)(dict As IPdfDict, key As PdfName, ByRef value As T(), singleToArray As Boolean, allowNulls As Boolean, addWarning As Boolean) As Boolean

Parameters

Type	Name	Description
IPdfDict	dict	The current dictionary.
PdfName	key	The key identifying the array.
T[]	value	OUT: The array of `T`.
bool	singleToArray	Indicates whether to convert a single `T` value to an array.
bool	allowNulls	Indicates whether to handle IPdfNull as null.
bool	addWarning	Indicates whether to add a warning to GrapeCity.Documents.Pdf.GcPdfDocument.ParserLog if errors occur.

Returns

Type	Description
bool	Returns true if no errors occur.

Type Parameters

Name	Description
T

TryGetArray<T>(IPdfDict, PdfName, out T[], bool)

Tries to get the array associated with the specified key, if the value does not exist or cannot be converted to an array of T returns false.

Declaration

public static bool TryGetArray<T>(this IPdfDict dict, PdfName key, out T[] value, bool singleToArray = false) where T : IPdfObject

Public Shared Function TryGetArray(Of T As IPdfObject)(dict As IPdfDict, key As PdfName, ByRef value As T(), Optional singleToArray As Boolean = False) As Boolean

Parameters

Type	Name	Description
IPdfDict	dict	The current dictionary.
PdfName	key	The key identifying the value.
T[]	value	OUT: The value.
bool	singleToArray	Indicates whether to convert a single `T` value to an array.

Returns

Type	Description
bool	true if value exists, false otherwise.

Type Parameters

Name	Description
T

TryGetArray Method