PdfNamespace Class

A structure tree namespace.

Declaration

public class PdfNamespace extends JavaObject

Remarks

The PdfNamespace class specifies a PDF namespace that associates structure elements with a namespace name, schema, and role mapping information.

Use the predefined PDF_17 and PDF_20 fields to access namespaces defined by PDF 1.7 and PDF 2.0 specifications.

Note

The StructureTree.getNamespaces() method returns namespace entries associated with the document’s structure tree. Use namespaces when you define custom structure types based on PDF 2.0 extension vocabularies or other non-standard structure vocabularies. Standard structure types defined by PDF 1.7 or PDF 2.0 do not require manual namespace configuration.

Refer to the following help topic for additional information: Generate and Edit Tagged PDF Documents.

Inherited Members

com.devexpress.system.JavaObject.clone()

com.devexpress.system.JavaObject.equals(java.lang.Object)

com.devexpress.system.JavaObject.hashCode()

com.devexpress.system.JavaObject.initFields()

com.devexpress.system.JavaObject.memberwiseClone()

com.devexpress.system.JavaObject.toString()

java.lang.Object.finalize()

java.lang.Object.getClass()

java.lang.Object.notify()

java.lang.Object.notifyAll()

java.lang.Object.wait()

java.lang.Object.wait(long)

java.lang.Object.wait(long,int)

Inheritance

Object

com.devexpress.system.JavaObject

PdfNamespace

PdfNamespace()

Initializes a new instance of the PdfNamespace class.

Declaration

public PdfNamespace()

Fields

PDF_17 Field

A namespace that corresponds to the PDF 1.7 specification.

Declaration

public static final PdfNamespace PDF_17

Field Value

Type	Description
PdfNamespace	The PDF 1.7 specification.

PDF_20 Field

A namespace that corresponds to the PDF 2.0 specification.

Declaration

public static final PdfNamespace PDF_20

Field Value

Type	Description
PdfNamespace	The PDF 2.0 specification.

Methods

getName() Method

Returns the namespace name.

Declaration

public String getName()

Returns

Type	Description
String	The namespace name.

getRoleMap() Method

Returns the role mapping collection for the namespace.

Declaration

public Map<String,PdfNamespaceRoleMapEntry> getRoleMap()

Returns

Type	Description
java.util.Map<java.lang.String,PdfNamespaceRoleMapEntry>	A map that contains role names.

getSchema() Method

Returns the file specification that defines the namespace schema.

Declaration

public FileSpecification getSchema()

Returns

Type	Description
FileSpecification	The namespace schema.

setName(String value) Method

Sets the namespace name.

Declaration

public void setName(String value)

Parameters

Name	Type	Description
value	String	The namespace name.

setSchema(FileSpecification value) Method

Sets the file specification that defines the namespace schema.

Declaration

public void setSchema(FileSpecification value)

Parameters

Name	Type	Description
value	FileSpecification	The namespace schema.