Class PdfName
Implementation of the name object.
Inheritance
Implements
Namespace: Syncfusion.Pdf.Primitives
Assembly: Syncfusion.Pdf.UWP.dll
Syntax
public class PdfName : Object, IPdfPrimitiveConstructors
PdfName()
Initializes a new instance of the PdfName class.
Declaration
public PdfName()PdfName(Enum)
Initializes a new instance of the PdfName class.
Declaration
public PdfName(Enum value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Enum | value | The enum value. |
PdfName(String)
Creates object with defined string value.
Declaration
public PdfName(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | Value of the string. |
Fields
Delimiters
PDF special characters.
Declaration
public static string DelimitersField Value
| Type |
|---|
| System.String |
Properties
ClonedObject
Returns cloned object.
Declaration
public IPdfPrimitive ClonedObject { get; }Property Value
| Type |
|---|
| IPdfPrimitive |
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 |
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 |
Value
Gets or sets the value of the object.
Declaration
public string Value { get; set; }Property Value
| Type |
|---|
| System.String |
Methods
Clone(PdfCrossTable)
Creates a copy of PdfName.
Declaration
public IPdfPrimitive Clone(PdfCrossTable crossTable)Parameters
| Type | Name | Description |
|---|---|---|
| PdfCrossTable | crossTable |
Returns
| Type |
|---|
| IPdfPrimitive |
Equals(Object)
Compares two PDF names.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj | PDFName to compare |
Returns
| Type | Description |
|---|---|
| System.Boolean | The result of comparison. |
EscapeString(String)
Replace some characters with its escape sequences.
Declaration
public static string EscapeString(string str)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | str | The string value. |
Returns
| Type | Description |
|---|---|
| System.String | Modified string. |
GetHashCode()
Returns a hash code for the name.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | The hash code. |
Save(IPdfWriter)
Saves the name using the specified writer.
Declaration
public void Save(IPdfWriter writer)Parameters
| Type | Name | Description |
|---|---|---|
| IPdfWriter | writer | The writer. |
ToString()
Gets string representation of the primitive.
Declaration
public override string ToString()Returns
| Type |
|---|
| System.String |
Operators
Equality(PdfName, PdfName)
Determines if two names are equal.
Declaration
public static bool operator ==(PdfName name1, PdfName name2)Parameters
| Type | Name | Description |
|---|---|---|
| PdfName | name1 | The name1. |
| PdfName | name2 | The name2. |
Returns
| Type |
|---|
| System.Boolean |
Equality(PdfName, Object)
Compares two names.
Declaration
public static bool operator ==(PdfName name1, object name2)Parameters
| Type | Name | Description |
|---|---|---|
| PdfName | name1 | The name1. |
| System.Object | name2 | The name2. |
Returns
| Type |
|---|
| System.Boolean |
Explicit(String to PdfName)
Explicit operator. Converts a string to a PdfName.
Declaration
public static explicit operator PdfName(string str)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | str | The string representation of the name. |
Returns
| Type | Description |
|---|---|
| PdfName | Properly initialized PdfName instance. |
Inequality(PdfName, PdfName)
Determines if two names aren't equal.
Declaration
public static bool operator !=(PdfName name1, PdfName name2)Parameters
| Type | Name | Description |
|---|---|---|
| PdfName | name1 | The name1. |
| PdfName | name2 | The name2. |
Returns
| Type |
|---|
| System.Boolean |
Inequality(PdfName, Object)
Determines if two names aren't equal.
Declaration
public static bool operator !=(PdfName name1, object name2)Parameters
| Type | Name | Description |
|---|---|---|
| PdfName | name1 | The name1. |
| System.Object | name2 | The name2. |
Returns
| Type |
|---|
| System.Boolean |