{"title":"Codeunit 9987 Word Template, procedures","url":"https://jonas-paprotka.de/ref/codeunit/9987-word-template/procedures/","author":"JOP-AL","license":"Metadata from Microsoft's symbol packages. AL source MIT, Copyright (c) Microsoft Corporation. Selection and wording © 2026 JOP-AL. https://jonas-paprotka.de/licenses/","subject":"Microsoft Dynamics 365 Business Central","checked":"2026-11-20","changed":"2026-10-05","object":{"type":"codeunit","id":9987,"name":"Word Template","app":"System Application","versions":"18-29","url":"https://jonas-paprotka.de/ref/codeunit/9987-word-template/","json":"https://jonas-paprotka.de/ref/codeunit/9987-word-template.json"},"aspect":"procedures","total":36,"rows":[{"name":"DownloadTemplate","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"DownloadDocument","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetTemplate","sig":"(var InStream)","named":"(var InStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(var InStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetDocument","sig":"(var InStream)","named":"(var DocumentInStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(var DocumentInStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Create","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Create","sig":"(Integer)","named":"(TableId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(TableId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Create","sig":"(Integer, List, List)","named":"(TableId: Integer; RelatedTableIds: List of [Integer]; RelatedTableCodes: List of [Code[5]])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(TableId: Integer; RelatedTableIds: List of [Integer]; RelatedTableCodes: List of [Code[5]])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Create","sig":"(List)","named":"(MergeFields: List of [Text])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(MergeFields: List of [Text])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Load","sig":"(Code[30])","named":"(WordTemplateCode: Code[30])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(WordTemplateCode: Code[30])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Load","sig":"(InStream)","named":"(WordTemplateStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(WordTemplateStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Dictionary)","named":"(Data: Dictionary of [Text, Text])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(Data: Dictionary of [Text, Text])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Dictionary, Enum Word Templates Save Format)","named":"(Data: Dictionary of [Text, Text]; SaveFormat: Enum \"Word Templates Save Format\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(Data: Dictionary of [Text, Text]; SaveFormat: Enum \"Word Templates Save Format\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Boolean)","named":"(SplitDocument: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(SplitDocument: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Boolean, Enum Word Templates Save Format)","named":"(SplitDocument: Boolean; SaveFormat: Enum \"Word Templates Save Format\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(SplitDocument: Boolean; SaveFormat: Enum \"Word Templates Save Format\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Variant, Boolean)","named":"(RecordVariant: Variant; SplitDocument: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(RecordVariant: Variant; SplitDocument: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Variant, Boolean, Enum Word Templates Save Format)","named":"(RecordVariant: Variant; SplitDocument: Boolean; SaveFormat: Enum \"Word Templates Save Format\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(RecordVariant: Variant; SplitDocument: Boolean; SaveFormat: Enum \"Word Templates Save Format\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddTable","sig":"(Integer)","named":"(TableID: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(TableID: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetTableId","sig":"()","named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddRelatedTable","sig":"(Code[30], Code[5], Integer, Integer, Integer)","named":"(WordTemplateCode: Code[30]; RelatedCode: Code[5]; TableId: Integer; RelatedTableId: Integer; FieldNo: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"18-29","first":18,"last":29,"obsoleteSince":null,"spans":[{"from":18,"to":29,"named":"(WordTemplateCode: Code[30]; RelatedCode: Code[5]; TableId: Integer; RelatedTableId: Integer; FieldNo: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"RemoveRelatedTable","sig":"(Code[30], Integer)","named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Replaced by RemoveTable below","tag":"22.0"},"range":"18-25","first":18,"last":25,"obsoleteSince":22,"spans":[{"from":18,"to":21,"named":"(WordTemplateCode: Code[30]; RelatedTableId: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null},{"from":22,"to":25,"named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Replaced by RemoveTable below","tag":"22.0"}}]},{"name":"GetDocumentSize","sig":"()","named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"19-29","first":19,"last":29,"obsoleteSince":null,"spans":[{"from":19,"to":29,"named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"Load","sig":"(InStream, Code[30])","named":"(WordTemplateStream: InStream; WordTemplateCode: Code[30])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(WordTemplateStream: InStream; WordTemplateCode: Code[30])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Dictionary, Enum Word Templates Save Format, Boolean)","named":"(Data: Dictionary of [Text, Text]; SaveFormat: Enum \"Word Templates Save Format\"; EditDoc: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(Data: Dictionary of [Text, Text]; SaveFormat: Enum \"Word Templates Save Format\"; EditDoc: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Dictionary, Enum Word Templates Save Format, Boolean, Enum Doc. Sharing Conflict Behavior)","named":"(Data: Dictionary of [Text, Text]; SaveFormat: Enum \"Word Templates Save Format\"; EditDoc: Boolean; DocSharingConflictBehavior: Enum \"Doc. Sharing Conflict Behavior\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(Data: Dictionary of [Text, Text]; SaveFormat: Enum \"Word Templates Save Format\"; EditDoc: Boolean; DocSharingConflictBehavior: Enum \"Doc. Sharing Conflict Behavior\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Variant, Boolean, Enum Word Templates Save Format, Boolean)","named":"(RecordVariant: Variant; SplitDocument: Boolean; SaveFormat: Enum \"Word Templates Save Format\"; EditDoc: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(RecordVariant: Variant; SplitDocument: Boolean; SaveFormat: Enum \"Word Templates Save Format\"; EditDoc: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Merge","sig":"(Variant, Boolean, Enum Word Templates Save Format, Boolean, Enum Doc. Sharing Conflict Behavior)","named":"(RecordVariant: Variant; SplitDocument: Boolean; SaveFormat: Enum \"Word Templates Save Format\"; EditDoc: Boolean; DocSharingConflictBehavior: Enum \"Doc. Sharing Conflict Behavior\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(RecordVariant: Variant; SplitDocument: Boolean; SaveFormat: Enum \"Word Templates Save Format\"; EditDoc: Boolean; DocSharingConflictBehavior: Enum \"Doc. Sharing Conflict Behavior\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetDefaultFields","sig":"(Code[30], Integer)","named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddUnrelatedTable","sig":"(Code[30], Code[5], Integer, Guid)","named":"(WordTemplateCode: Code[30]; PrefixCode: Code[5]; UnrelatedTableId: Integer; RecordSystemId: Guid)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(WordTemplateCode: Code[30]; PrefixCode: Code[5]; UnrelatedTableId: Integer; RecordSystemId: Guid)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetExcludedFields","sig":"(Code[30], Integer, List)","named":"(WordTemplateCode: Code[30]; TableId: Integer; ExcludeFieldNames: List of [Text[30]])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(WordTemplateCode: Code[30]; TableId: Integer; ExcludeFieldNames: List of [Text[30]])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetExcludedFields","sig":"(Code[30], Integer)","named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetCustomTableFields","sig":"(Integer)","named":"(TableId: Integer)","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(TableId: Integer)","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetSupportedTableFields","sig":"(Integer)","named":"(TableId: Integer)","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(TableId: Integer)","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsFieldSupported","sig":"(Record Field)","named":"(Field: Record Field)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(Field: Record Field)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"RemoveTable","sig":"(Code[30], Integer)","named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetChildren","sig":"(Code[30], Integer)","named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"22-29","first":22,"last":29,"obsoleteSince":null,"spans":[{"from":22,"to":29,"named":"(WordTemplateCode: Code[30]; TableId: Integer)","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetMergeFields","sig":"(var List)","named":"(var Value: List of [Text])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var Value: List of [Text])","returns":"","kind":"procedure","access":"public","obsolete":null}]}]}