FileSpecification Class Documentation

class FileSpecification : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

Refers to the location of a PDF file within a file system.

The PDF file system is known more commonly as the file path name.

The reference can be either absolute, as in a complete path name, or relative to the current place in a directory structure.

Uses types

Constructor & Destructor Documentation

FileSpecification

FileSpecification(Document doc, string path)

Parameters

doc: Document

The document in which the file specification is created.

path: string

The string corresponding to the path of the file to reference. It may be relative or absolute.

Creates a new file specification object.

Property Documentation

PDFObject

PDFObject PDFObject[get]

Retrieve the PDFObject representation of this object.

Path

string Path[get]

Gets the path to the file referenced.

Member Function Documentation

Dispose

void Dispose()

Returns:

void

ToString

override string ToString()

Returns:

override string

The path to the file referenced by this FileSpecification.

Returns a string representation of this FileSpecification.

The returned value is the file path referenced by this specification.