FaxDocument object
The FaxDocument messaging object is used by a fax client application to compose a fax document and submit it to the fax service for processing.
Members
The FaxDocument object has these types of members:
Methods
The FaxDocument object has these methods.
| Method | Description |
|---|---|
| [ConnectedSubmit](-mfax-faxdocument-connectedsubmit.md) | The [ConnectedSubmit](-mfax-faxdocument-connectedsubmit.md) method submits a single fax document to the connected [FaxServer](-mfax-faxserver.md). The method returns an array of fax job ID strings, one for each recipient of the fax. |
| [ConnectedSubmit2](-mfax-faxdocument2-connectedsubmit2-vb.md) | Submits one or more fax documents to the connected [FaxServer](-mfax-faxserver.md). This method returns an array of fax job ID strings, one for each recipient of the fax.[!Note] |
| [Submit](-mfax-faxdocument-submit-vb.md) | The [Submit](-mfax-faxdocument-submit-vb.md) method submits a single fax document to the fax service for processing. |
| [Submit2](-mfax-faxdocument2-submit2-vb.md) | Submits one or more documents to the fax service for processing.[!Note] |
Properties
The FaxDocument object has these properties.
| Property | Access type | Description |
|---|---|---|
| [AttachFaxToReceipt](-mfax-faxdocument-attachfaxtoreceipt-vb.md) |
Read/write |
The [AttachFaxToReceipt](-mfax-faxdocument-attachfaxtoreceipt-vb.md) property indicates whether to attach a fax to the receipt. |
| [Bodies](-mfax-faxdocument2-bodies-vb.md) |
Read/write |
Provides a collection of one or more documents to the fax document. [!Note] |
| [Body](-mfax-faxdocument-body-vb.md) |
Read/write |
The [Body](-mfax-faxdocument-body-vb.md) property provides the path to the file that comprises the body of a fax. The body of a fax consists of the fax pages other than the cover page. |
| [CoverPage](-mfax-faxdocument-coverpage-vb.md) |
Read/write |
The [CoverPage](-mfax-faxdocument-coverpage-vb.md) property is a null-terminated string that contains the name of the cover page template file (.cov) to associate with the fax document. |
| [CoverPageType](-mfax-faxdocument-coverpagetype-vb.md) |
Read/write |
The [CoverPageType](-mfax-faxdocument-coverpagetype-vb.md) property is a value from an enumeration that indicates whether a specified cover page template file (.cov) is a server-based cover page file or a local-computer-based cover page file. You can also specify that no file is used. |
| [DocumentName](-mfax-faxdocument-documentname-vb.md) |
Read/write |
The [DocumentName](-mfax-faxdocument-documentname-vb.md) property is a null-terminated string that contains the user-friendly name to display for the fax document. The value is for display purposes only. |
| [GroupBroadcastReceipts](-mfax-faxdocument-groupbroadcastreceipts-vb.md) |
Read/write |
The [GroupBroadcastReceipts](-mfax-faxdocument-groupbroadcastreceipts-vb.md) property is a Boolean value that indicates whether to send an individual delivery receipt for each recipient of the broadcast, or to send a summary receipt for all the recipients. |
| [Note](-mfax-faxdocument-note-vb.md) |
Read/write |
The [Note](-mfax-faxdocument-note-vb.md) property is a null-terminated string that contains the contents of the note field on the cover page of the fax. |
| [Priority](-mfax-faxdocument-priority-vb.md) |
Read/write |
The [Priority](-mfax-faxdocument-priority-vb.md) property specifies the priority to use when sending the fax; for example, normal, low, or high priority. |
| [ReceiptAddress](-mfax-faxdocument-receiptaddress-vb.md) |
Read/write |
The [ReceiptAddress](-mfax-faxdocument-receiptaddress-vb.md) property is a null-terminated string that indicates the email address to which the fax service should send a delivery receipt when the fax job reaches a final state. |
| [ReceiptType](-mfax-faxdocument-receipttype-vb.md) |
Read/write |
The [ReceiptType](-mfax-faxdocument-receipttype-vb.md) property specifies the type of delivery receipt to deliver when the fax job reaches a final state. |
| [Recipients](-mfax-faxdocument-recipients-vb.md) |
Read-only |
The [Recipients](-mfax-faxdocument-recipients-vb.md) property retrieves a collection of one or more recipients for the fax document. |
| [ScheduleTime](-mfax-faxdocument-scheduletime-vb.md) |
Read/write |
The [ScheduleTime](-mfax-faxdocument-scheduletime-vb.md) property indicates the time to submit the fax for processing to the fax service. |
| [ScheduleType](-mfax-faxdocument-scheduletype-vb.md) |
Read/write |
The [ScheduleType](-mfax-faxdocument-scheduletype-vb.md) property indicates when to schedule the fax job; for example, you can specify that the fax service send the fax immediately, at a specified time, or during a predefined discount period. |
| [Sender](-mfax-faxdocument-sender-vb.md) |
Read-only |
Retrieves an object containing information about the sender of the fax document. |
| [Subject](-mfax-faxdocument-subject-vb.md) |
Read/write |
The [Subject](-mfax-faxdocument-subject-vb.md) property is a null-terminated string that contains the contents of the subject field on the cover page of the fax. |
| [SubmissionId](-mfax-faxdocument2-submissionid-vb.md) |
Read-only |
Retrieves the submission identifier for the fax document. Every job in a given broadcast receives the same submission identifier.[!Note] |
Remarks
The FaxDocument object implements the IFaxDocument interface in Windows XP and earlier. It implements the IFaxDocument2 interface in Windows Vista and later.
Use the FaxDocument object to set and retrieve information about fax transmissions. This includes information about fax recipients, contained in the FaxRecipients object, and information about the fax sender, contained in the FaxSender object.
You can send a fax to one or more recipients.
To create a FaxDocument object in Microsoft Visual Basic, call the Visual Basic CreateObject function.
To create a FaxDevices object in C++, call the CoCreateInstance function. An example of the creation of a FaxDocument object is provided in the topic Creating the Root Object in C++.
Requirements
| Minimum supported client |
Windows XP [desktop apps only] |
| Minimum supported server |
Windows Server 2003 [desktop apps only] |
| Header |
|
| DLL |
|
| IID |
CLSID_FaxDocument |
See also