FaxAttachment Object

The FaxAttachment object represents a single document that is an attachment to a fax message.

Properties

* - Read/write properties marked with an asterisk are Read-Only when the attachment object is contained within a "Sent" message.

Methods

Back to Top

DefaultFileExtension

The DefaultFileExtension property returns a well-known file extension based on the file type. Read-only.

Syntax

ObjAttachment.DefaultFileExtension

Data Type

String

Remarks

Valid values for this property are defined by the FaxMsg_FileType enumeration.

Back to Top

Delete Method

The Delete method removes the FaxAttachment object from its parent FaxAttachments collection, and deletes any fax server based resources associated with the FaxAttachment object.

Syntax

ObjAttachment.Delete( )

Remarks

The Delete method will permanently delete the attachment object - the operation cannot be undone.

Back to Top

DeleteMode Property

The DeleteMode property controls when an attachment file submitted to the fax server is deleted. Read/write*.

Syntax

ObjAttachment.DeleteMode

Data Type

Long

Remarks

Valid values for this property are defined by the FaxMsg_DeleteMode enumeration.

The property value FaxMsg_DeleteMode_Done will cause the attachment file to be deleted after transmission is complete. The property value FaxMsg_DeleteMode_Purge will cause the attachment file to be deleted when the event/fax message is deleted.

*The DeleteMode property is Read-Only when the attachment object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

DisplayName Property

The DisplayName property returns or sets the display name of the attachment. Read/write*.

Syntax

ObjAttachment.DisplayName

Data Type

String

Remarks

*The DisplayName property is Read-Only when the attachment object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

FileOnServer Property

Documentation forthcoming.

Syntax

ObjAttachment.FileOnServer

Data Type

Bool

Remarks

Back to Top

FileName Property

The FileName property returns or sets the name of the file attachment. Read/write*.

Syntax

ObjAttachment.FileName

Data Type

String

Remarks

*The FileName property is Read-Only when the attachment object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

Font Property

The Font property returns or sets the name of the font used in ASCII file attachment types. Read/write*.

Syntax

ObjAttachment.Font

Data Type

String

Remarks

*The Font property is Read-Only when the attachment object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

Index Property

The Index property returns the index of the attachment object within its parent FaxAttachments collection. The index reflects this attachment’s position within the parent collection. Read-only.

Syntax

ObjAttachment.Index

Data Type

Long

Remarks

An attachment's Index property may change if other attachment items are removed from the parent FaxAttachments collection.

The first object in the collection has an Index value of 1.

Back to Top

Pages Property

The Pages property returns the total number of pages in the attachment. Read-only.

Syntax

ObjAttachment.Pages

Data Type

Long

Back to Top

Resolution Property

The Resolution property returns or sets the resolution of the attachment. Read/write*.

Syntax

ObjAttachment.Resolution

Data Type

Long

Remarks

Valid values for this property are defined by the FaxMsg_Resolution enumeration.

*The Resolution property is Read-Only when the attachment object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

ScaleToWidth Property

The ScaleToWidth property scales the graphic image attachment to a standard page width. A small image attachment is enlarged or a large image attachment is reduced to fit onto a standard page size. The aspect ratio of all scaled images is maintained. Read/write*.

Syntax

ObjAttachment.ScaleToWidth

Data Type

Boolean

Remarks

*The ScaleToWidth property is Read-Only when the attachment object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

SeamWithNext Property

The SeamWithNext property eliminates page breaks when faxing multiple attachments. This option is desirable when the file contents do not require a full page. Read/write*.

Syntax

ObjAttachment.SeamWithNext

Data Type

Boolean

Remarks

*The SeamWithNext property is Read-Only when the attachment object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

Back to Top

Type Property

The Type property returns or sets the file type of the attachment object. Read/write*.

Syntax

ObjAttachment.Type

Data Type

Long

Remarks

Valid values for this property are defined by the FaxMsg_FileType enumeration.

*The Type property is Read-Only when the attachment object is contained within a "sent" message. After the fax message has been sent, any change to this property is ignored.

The Type property can be set at the time of creation of the attachment by supplying the type parameter to the Add method of the FaxAttachments collection.

Back to Top

Update Method

The Update method updates the attachment contents with another file.

Syntax

ObjAttachment.Update( )

Remarks

The Update method will replace the existing attachment with the specified filename.

Back to Top

WriteToFile Method

The WriteToFile method saves the attachment to a file in the file system.

Syntax

ObjAttachment.WriteToFile(FileName)

Remarks

The FileName parameter is a string representing the full path and file name for the saved attachment.

The WriteToFile method will overwrite a file without warning if a file of that name already exists. Your application should check for the existence of the file before calling the WriteToFile method.

Back to Top