Class FileSpecification

Represents a PDF File Specification.

The complex architecture of this class is based on the PDF Specification, for full details please consult that spec.

See

FileSpecificationProperties

Hierarchy (View Summary)

ObjectBase
- FileSpecification

Index

Constructors

constructor

new FileSpecification(
om: ObjectManager,
properties: FileSpecificationProperties,
): FileSpecification
Creates a FileSpecification object on the base of properties specified by the FileSpecificationProperties.
Parameters
- om: ObjectManager
  ObjectManager that controls the lifetime of the FileSpecification.
- properties: FileSpecificationProperties
  The properties of created object.
Returns FileSpecification
Overrides ObjectBase.constructor
new FileSpecification(
properties: FileSpecificationProperties,
): FileSpecification
Creates a FileSpecification object on the base of properties specified by the FileSpecificationProperties.
Parameters
- properties: FileSpecificationProperties
  The properties of created object.
Returns FileSpecification
Overrides ObjectBase.constructor
new FileSpecification(
    om: ObjectManager,
    fileName: string,
    stream: EmbeddedFileStream,
    desc?: string,
): FileSpecification
Creates a FileSpecification associated with the specified EmbeddedFileStream object.
Parameters
- om: ObjectManager
  ObjectManager that controls the lifetime of the FileSpecification.
- fileName: string
  The file name used as a name for embedded file.
- stream: EmbeddedFileStream
  The EmbeddedFileStream associated with created file specification.
- Optionaldesc: string
  The optional description.
Returns FileSpecification
Overrides ObjectBase.constructor
new FileSpecification(
    fileName: string,
    stream: EmbeddedFileStream,
    desc?: string,
): FileSpecification
Creates a FileSpecification associated with the specified EmbeddedFileStream object.
Parameters
- fileName: string
  The file name used as a name for embedded file.
- stream: EmbeddedFileStream
  The EmbeddedFileStream associated with created file specification.
- Optionaldesc: string
  The optional description.
Returns FileSpecification
Overrides ObjectBase.constructor

Accessors

desc

get desc(): string | null
Gets or sets the description of this File Specification.

Returns string | null
set desc(value: string | null): void
Gets or sets the description of this File Specification.
Parameters
- value: string | null
Returns void

fileSystem

get fileSystem(): string | null
Gets or sets the file system to be used to interpret this file specification.

If this property is present, all other properties are interpreted by the designated file system. PDF defines only one standard file system name, URL; an application or plug-in extension can register other names.

Returns string | null
set fileSystem(value: string | null): void
Gets or sets the file system to be used to interpret this file specification.

If this property is present, all other properties are interpreted by the designated file system. PDF defines only one standard file system name, URL; an application or plug-in extension can register other names.
Parameters
- value: string | null
Returns void

hasEmbeddedFileStream

get hasEmbeddedFileStream(): boolean
Gets a value indicating that this file specification has at least one EmbeddedFileStream associated with it.

Returns boolean

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from ObjectBase.id

ID

get ID(): FileID | null
Gets or sets the FileID object specifying the ID of the referenced file.

This property improves an application's chances of finding the intended file and allows it to warn the user if the file has changed since the link was made.

Returns FileID | null
set ID(value: FileID | null): void
Gets or sets the FileID object specifying the ID of the referenced file.

This property improves an application's chances of finding the intended file and allows it to warn the user if the file has changed since the link was made.
Parameters
- value: FileID | null
Returns void

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from ObjectBase.om

relationship

get relationship(): string | null
Gets or sets a value that represents the relationship of this object to the source that points to it.

Predefined values are Source, Data, Alternative, Supplement and Unspecified.

Returns string | null
set relationship(value: string | null): void
Gets or sets a value that represents the relationship of this object to the source that points to it.

Predefined values are Source, Data, Alternative, Supplement and Unspecified.
Parameters
- value: string | null
Returns void

volatile

get volatile(): boolean
Gets or sets a value indicating whether the file referenced by the file specification is volatile (changes frequently with time). If the value is true, applications should never cache a copy of the file.

Returns boolean
set volatile(value: boolean): void
Gets or sets a value indicating whether the file referenced by the file specification is volatile (changes frequently with time). If the value is true, applications should never cache a copy of the file.
Parameters
- value: boolean
Returns void

Methods

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from ObjectBase.free

getStream

getStream(): Uint8Array<ArrayBufferLike> | null
Gets a value indicating that this file specification has at least one EmbeddedFileStream associated with it.

Returns Uint8Array<ArrayBufferLike> | null

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from ObjectBase.rebind

Class FileSpecification

See

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns FileSpecification

Parameters

Returns FileSpecification

Parameters

Returns FileSpecification

Parameters

Returns FileSpecification

Accessors

desc

Returns string | null

Parameters

Returns void

fileSystem

Returns string | null

Parameters

Returns void

hasEmbeddedFileStream

Returns boolean

id

Returns number

ID

Returns FileID | null

Parameters

Returns void

om

Returns ObjectManager

relationship

Returns string | null

Parameters

Returns void

volatile

Returns boolean

Parameters

Returns void

Methods

free

Returns void

getStream

Returns Uint8Array<ArrayBufferLike> | null

rebind

Parameters

Returns void

Settings

On This Page