Class PdfDictionary

Inheritance

System.Object

PdfDictionary

PdfResources

PdfStream

Implements

IPdfPrimitive

Namespace: Syncfusion.Pdf.Primitives

Assembly: Syncfusion.Pdf.UWP.dll

Syntax

public class PdfDictionary : Object, IPdfPrimitive, IPdfChangable

Constructors

PdfDictionary()

Initializes a new empty instance of the PdfDictionary class.

Declaration

public PdfDictionary()

Properties

Changed

Gets a value indicating whether this PdfDictionary is changed.

Declaration

public bool Changed { get; }

Property Value

Type	Description
System.Boolean	true if changed; otherwise, false.

ClonedObject

Returns cloned object.

Declaration

public virtual IPdfPrimitive ClonedObject { get; }

Property Value

Type
IPdfPrimitive

Count

Gets the count.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

IsSaving

Gets or sets a value indicating whether this document is saving or not.

Declaration

public bool IsSaving { get; set; }

Property Value

Type
System.Boolean

Item[PdfName]

Gets or sets the IPdfSavable with the specified key.

Declaration

public IPdfPrimitive this[PdfName key] { get; set; }

Parameters

Type	Name	Description
PdfName	key

Property Value

Type
IPdfPrimitive

Item[String]

Gets or sets the IPdfSavable with the specified key.

Declaration

public IPdfPrimitive this[string key] { get; set; }

Parameters

Type	Name	Description
System.String	key

Property Value

Type
IPdfPrimitive

Items

Gets the items.

Declaration

public Dictionary<PdfName, IPdfPrimitive> Items { get; }

Property Value

Type
System.Collections.Generic.Dictionary<PdfName, IPdfPrimitive>

ObjectCollectionIndex

Gets or sets the integer value of the specified object.

Declaration

public int ObjectCollectionIndex { get; set; }

Property Value

Type
System.Int32

Position

Gets or sets the position of the object.

Declaration

public int Position { get; set; }

Property Value

Type
System.Int32

Status

Gets or sets the Status of the specified object.

Declaration

public ObjectStatus Status { get; set; }

Property Value

Type
ObjectStatus

Values

Gets the values.

Declaration

public Dictionary<PdfName, IPdfPrimitive>.ValueCollection Values { get; }

Property Value

Type
System.Collections.Generic.Dictionary.ValueCollection<>

Methods

Clear()

Clears items from object dictionary.

Declaration

public void Clear()

Clone(PdfCrossTable)

Creates a copy of PdfDictionary.

Declaration

public virtual IPdfPrimitive Clone(PdfCrossTable crossTable)

Parameters

Type	Name	Description
PdfCrossTable	crossTable

Returns

Type
IPdfPrimitive

ContainsKey(PdfName)

Determines whether the dictionary contains the key.

Declaration

public bool ContainsKey(PdfName key)

Parameters

Type	Name	Description
PdfName	key	The key.

Returns

Type	Description
System.Boolean	true if the dictionary contains the key; otherwise, false.

ContainsKey(String)

Determines whether the dictionary contains key.

Declaration

public bool ContainsKey(string key)

Parameters

Type	Name	Description
System.String	key	The key.

Returns

Type	Description
System.Boolean	true if the dictionary contains key; otherwise, false.

FreezeChanges(Object)

Freezes the changes.

Declaration

public void FreezeChanges(object freezer)

Parameters

Type	Name	Description
System.Object	freezer	The freezer.

GetName(String)

Creates a PDF name object.

Declaration

protected PdfName GetName(string name)

Parameters

Type	Name	Description
System.String	name	The string which the object is initialized with.

Returns

Type	Description
PdfName	The PDF object.

GetValue(PdfCrossTable, String, String)

Gets a value from itself or one of the parent dictionaries.

Declaration

public IPdfPrimitive GetValue(PdfCrossTable crossTable, string key, string parentKey)

Parameters

Type	Name	Description
PdfCrossTable	crossTable	The cross table.
System.String	key	The key of the value.
System.String	parentKey	The key to the parent.

Returns

Type	Description
IPdfPrimitive	The value by the key.

GetValue(String, String)

Gets a value from itself or one of the parent dictionaries.

Declaration

public IPdfPrimitive GetValue(string key, string parentKey)

Parameters

Type	Name	Description
System.String	key	The key of the value.
System.String	parentKey	The key to the parent.

Returns

Type	Description
IPdfPrimitive	The value by the key.

OnBeginSave(SavePdfPrimitiveEventArgs)

Raises event Syncfusion.Pdf.Primitives.PdfDictionary.BeginSave.

Declaration

protected virtual void OnBeginSave(SavePdfPrimitiveEventArgs args)

Parameters

Type	Name	Description
SavePdfPrimitiveEventArgs	args	Event arguments.

OnEndSave(SavePdfPrimitiveEventArgs)

Raises event Syncfusion.Pdf.Primitives.PdfDictionary.EndSave.

Declaration

protected virtual void OnEndSave(SavePdfPrimitiveEventArgs args)

Parameters

Type	Name	Description
SavePdfPrimitiveEventArgs	args	Event arguments.

Remove(PdfName)

Removes the specified key.

Declaration

public void Remove(PdfName key)

Parameters

Type	Name	Description
PdfName	key	The key.

Remove(String)

Removes the specified key.

Declaration

public void Remove(string key)

Parameters

Type	Name	Description
System.String	key	The key.

Save(IPdfWriter)

Saves the object using the specified writer.

Declaration

public virtual void Save(IPdfWriter writer)

Parameters

Type	Name	Description
IPdfWriter	writer	The writer.

Implements

IPdfPrimitive

Extension Methods

DateTimeExtension.ToDateTime(Object)