-
Classes
- AcroForm
- ActionBase
- ActionFieldsBase
- ActionGoTo
- ActionGoToR
- ActionHide
- ActionImportData
- ActionJavaScript
- ActionJavaScriptMap
- ActionLaunch
- ActionLaunchWinAttrs
- ActionNamed
- ActionResetForm
- ActionSound
- ActionSubmitForm
- ActionUnknown
- ActionUri
- AnnotationBase
- AnnotationCollection
- AnnotationPagesCollection
- AppearanceStream
- AppearanceStreams
- AssociatedFiles
- Attr
- AttrClsRevision
- AttrClsRevisionCollection
- AttrCollection
- AttrRevision
- AttrRevisionCollection
- BilevelBitmap
- Bitmap
- BmpContext
- Border
- BorderEffect
- Brush
- ButtonAppearance
- CaretAnnotation
- CheckBoxField
- ChoiceField
- CircleAnnotation
- ClassMap
- ComboBoxField
- CombTextField
- ContentItemLink
- ContentItemLinkCollection
- DefaultAppearance
- Destination
- DestinationBase
- DestinationFit
- DestinationFitB
- DestinationFitBh
- DestinationFitBv
- DestinationFitH
- DestinationFitR
- DestinationFitV
- DestinationRef
- DestinationUnknown
- DestinationXyz
- DocAction
- DocumentDestinations
- DocumentInfo
- DocumentSecurityStore
- DrawingContext
- DsPdf
- DsPdfConfig
- EmbeddedFileStream
- Field
- FieldCollection
- FieldWidgetCollection
- FileAttachmentAnnotation
- FileInfo
- FileSpecification
- FileSpecificationMap
- Font
- FontCollection
- FontHandler
- FontHandlerCollection
- Format
- FormXObject
- FreeTextAnnotation
- GraphicsPath
- GrayscaleBitmap
- HatchBrush
- IccProfile
- Image
- ImageBrush
- InkAnnotation
- Layout
- LineAnnotation
- LinearGradientBrush
- LinkAnnotation
- ListBoxField
- MarkInfo
- MarkupAnnotation
- McidContentItemLink
- McrContentItemLink
- Metadata
- Model3DAnnotation
- Model3DStream
- Model3DView
- Model3DViewCollection
- Namespace
- NamespaceCollection
- ObjectBase
- ObjectManager
- ObjrContentItemLink
- OutlineNode
- OutlineNodeCollection
- OutputIntent
- OutputIntentCollection
- PageLabelingRange
- PageLabelingRangeMap
- PdfCidFont
- PdfCidFontType0
- PdfCidFontType2
- PdfCidFontUnknown
- PdfCMapTable
- PdfContext
- PdfDocument
- PdfFont
- PdfFontDescriptor
- PdfFontSimple
- PdfFontTrueType
- PdfFontType0
- PdfFontType1
- PdfFontType3
- PdfImageHandler
- PdfImageHandlerCollection
- PdfPage
- PdfPageCollection
- PdfSignature
- Pen
- Pkcs7Signer
- Pkcs7SignerBase
- PolygonAnnotation
- PolygonAnnotationBase
- PolyLineAnnotation
- PopupAnnotation
- PushButtonField
- RadialGradientBrush
- RadioButtonField
- RContentItemLink
- RedactAnnotation
- RichMediaAnnotation
- RoleMap
- Security
- SecurityHandlerBase
- SignatureField
- SolidBrush
- SoundAnnotation
- SoundObject
- SplitOptions
- SquareAnnotation
- StampAnnotation
- StandardSecurityHandler
- StandardSecurityHandlerRev2
- StandardSecurityHandlerRev3
- StandardSecurityHandlerRev4
- StandardSecurityHandlerRev5
- StandardSecurityHandlerRev6
- StructElement
- StructElementCollection
- StructTreeItem
- StructTreeItemCollection
- StructTreeRoot
- SvgContext
- SvgDocument
- TextAnnotation
- TextField
- TextMarkupAnnotation
- TimeStamper
- TimeStampProvider
- Transform
- UnknownAnnotation
- UnknownSecurityHandler
- WatermarkAnnotation
- WidgetAnnotation
- Enumerations
- Functions
- Interfaces
- README
- Index
- TypeAliases
- Variables
FileSpecification
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
Extends
Constructors
Constructor
new FileSpecification(om, properties): FileSpecification;
Creates a FileSpecification object on the base of properties specified by the FileSpecificationProperties.
Parameters
om
ObjectManager that controls the lifetime of the FileSpecification.
properties
The properties of created object.
Returns
FileSpecification
Overrides
ObjectBase.constructor
Constructor
new FileSpecification(properties): FileSpecification;
Creates a FileSpecification object on the base of properties specified by the FileSpecificationProperties.
Parameters
properties
The properties of created object.
Returns
FileSpecification
Overrides
ObjectBase.constructor
Constructor
new FileSpecification(
om,
fileName,
stream,
desc?): FileSpecification;
Creates a FileSpecification associated with the specified EmbeddedFileStream object.
Parameters
om
ObjectManager that controls the lifetime of the FileSpecification.
fileName
string
The file name used as a name for embedded file.
stream
The EmbeddedFileStream associated with created file specification.
desc?
string
The optional description.
Returns
FileSpecification
Overrides
ObjectBase.constructor
Constructor
new FileSpecification(
fileName,
stream,
desc?): FileSpecification;
Creates a FileSpecification associated with the specified EmbeddedFileStream object.
Parameters
fileName
string
The file name used as a name for embedded file.
stream
The EmbeddedFileStream associated with created file specification.
desc?
string
The optional description.
Returns
FileSpecification
Overrides
ObjectBase.constructor
Accessors
desc
Get Signature
get desc(): string;
Gets or sets the description of this File Specification.
Returns
string
Set Signature
set desc(value): void;
Gets or sets the description of this File Specification.
Parameters
value
string
Returns
void
dosFile
Get Signature
get dosFile(): FileInfo;
Gets the FileInfo object defining information about the referenced file for the DOS platform. NOTE: Using this property is not recommended beginning with PDF 1.7.
Returns
file
Get Signature
get file(): FileInfo;
Gets the FileInfo object that specifies information about a referenced file. Note that this property should be used for files with names containing ASCII characters only, and is provided for backwards compatibility. For file names that contain non-ASCII characters, unicodeFile should be used instead.
See
Returns
fileSystem
Get Signature
get fileSystem(): string;
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
Set Signature
set fileSystem(value): 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
Returns
void
hasEmbeddedFileStream
Get Signature
get hasEmbeddedFileStream(): boolean;
Gets a value indicating that this file specification has at least one EmbeddedFileStream associated with it.
Returns
boolean
id
Get Signature
get id(): number;
Gets the reference to the object.
Returns
number
Inherited from
ID
Get Signature
get ID(): FileID;
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
Set Signature
set ID(value): 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
Returns
void
macFile
Get Signature
get macFile(): FileInfo;
Gets the FileInfo object defining information about the referenced file for the Mac OS platform. NOTE: Using this property is not recommended beginning with PDF 1.7.
Returns
om
Get Signature
get om(): ObjectManager;
Gets the owner ObjectManager instance.
Returns
Inherited from
relationship
Get Signature
get relationship(): string;
Gets or sets a value that represents the relationship of this object to the source that points to it. The FileSpecificationRelationshipType defines values from PDF specification.
Returns
string
Set Signature
set relationship(value): void;
Gets or sets a value that represents the relationship of this object to the source that points to it. The FileSpecificationRelationshipType defines values from PDF specification.
Parameters
value
string
Returns
void
unicodeFile
Get Signature
get unicodeFile(): FileInfo;
Gets the FileInfo object that specifies information about a referenced file.
See
Returns
unixFile
Get Signature
get unixFile(): FileInfo;
Gets the FileInfo object defining information about the referenced file for the Unix platform. NOTE: Using this property is not recommended beginning with PDF 1.7.
Returns
volatile
Get Signature
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 Signature
set volatile(value): 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
getStream()
getStream(): Uint8Array<ArrayBufferLike>;
Gets a value indicating that this file specification has at least one EmbeddedFileStream associated with it.
Returns
Uint8Array<ArrayBufferLike>
rebind()
rebind(omTo): void;
Rebinds the object from the current ObjectManager to the specified one.
Parameters
omTo
The new ObjectManager for the object.
Returns
void