Page WSB_DMTMailTemplateEditor¶
A page to edit the contents of a Document Mail Template with a rich text editor.
Properties¶
| Name | Value |
|---|---|
| ApplicationArea | #All |
| Caption | Mail Template |
| ContextSensitiveHelpPage | Editing-a-Mail-Template.html |
| DeleteAllowed | False |
| Extensible | True |
| InsertAllowed | False |
| PageType | Card |
| UsageCategory | None |
Methods¶
wgFncGetMailTemplateContent¶
Returns the current contents of the mail template file, including any pending edits.
Returns¶
| Type | Description |
|---|---|
Text |
The mail template file contents. |
wgFncSetDetachedMailTemplate¶
Sets the mail template to edit in detached mode, i.e., without a backing report layout record. Use this when the mail template comes from an external source such as a Document Mail Templates Support File. The caller retrieves the edited contents via <see cref="wgFncGetMailTemplateContent" /> after the page closes.
Parameters¶
| Type | Name | Description |
|---|---|---|
Text |
pTemplateContent |
The initial mail template file contents. |
Integer |
pReportID |
The ID of the report that the mail template belongs to, used to look up placeholder metadata. |
Text[250] |
pLayoutName |
The name of the mail template layout, shown in the editor for context. |
Text[250] |
pLayoutDescription |
The description of the mail template layout, shown in the editor for context. |
wgFncSetDetachedPreviewDataset¶
Provides a report XML dataset to use for previewing the mail template when the editor is in detached mode. Without a dataset, the Preview Email Body action is disabled in detached mode.
Parameters¶
| Type | Name | Description |
|---|---|---|
Codeunit "Temp Blob" |
pCduTempBlobDataset |
The Temp Blob containing the report XML dataset. |
wgFncSetDetachedPreviewDataset¶
Provides a detached preview dataset and its schema for binary text decoding.
Parameters¶
| Type | Name | Description |
|---|---|---|
Codeunit "Temp Blob" |
pCduTempBlobDataset |
The report XML dataset. |
Text |
pWordXmlPart |
The customized Word XML part containing column data types. |
wgFncSetMailTemplate¶
Sets the mail template to edit.
Parameters¶
| Type | Name | Description |
|---|---|---|
Record "Report Layout List" |
pRecReportLayoutList |
The report layout that holds the mail template. |
wgFncSetViewOnly¶
Opens the mail template in read-only mode; suppresses saves and disables modifying actions.
Parameters¶
| Type | Name | Description |
|---|---|---|
Boolean |
pViewOnly |
Whether to open the mail template in view-only mode. |