FileSpecification

FileSpecification class

Class representing embedded file.

The FileSpecification type exposes the following members:

Constructors

NameDescription
FileSpecification(file)Initializes a new instance of the FileSpecification class
FileSpecification(stream, name)Initializes a new instance of the FileSpecification class
FileSpecification(file, description)Initializes a new instance of the FileSpecification class
FileSpecification(stream, name, description)Initializes a new instance of the FileSpecification class
FileSpecification(file_name, annot)Initializes a new instance of the FileSpecification class
FileSpecification()Create new empty file specification.

Properties

NameDescription
encodingGets or sets encoding format.
Possible values: Zip - file is compressed with ZIP,
None - file is not compressed.
include_contentsIf true, contents of the file will be included in the file specification.
encrypted_payloadGets encrypted payload.
descriptionGets or sets text associated with the file specification.
af_relationshipAssociated file Relationship.
stream_contentsGets contents of file as stream.
Contents is not loaded into memory which allows to decrease memory usage.
But this stream does not support positioning and Length property. If you need this features please use Contents property instead.
contentsGets or sets contents file.
This property returns data loaded in memory which may cause Out of memory exception for large data.
To decrease memory usage please use StreamContents.
paramsGets file paramteres.
mime_typeGets subtype of the embedded file
nameGets or sets file specification name.
unicode_nameGets or sets file specification unicode name.
file_systemGets or sets name of the file system.

Methods

NameDescription
get_value(key)Gets application-specific parameter.
set_value(key, value)Sets application-specific parameter.

See Also