{"title":"Codeunit 9651 Document Report Mgt., procedures","url":"https://jonas-paprotka.de/ref/codeunit/9651-document-report-mgt/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":9651,"name":"Document Report Mgt.","app":"Base Application","versions":"17-29","url":"https://jonas-paprotka.de/ref/codeunit/9651-document-report-mgt/","json":"https://jonas-paprotka.de/ref/codeunit/9651-document-report-mgt.json"},"aspect":"procedures","total":17,"rows":[{"name":"MergeWordLayout","sig":"(Integer, Option, InStream, Text)","named":"(ReportID: Integer; ReportAction: Option SaveAsPdf,SaveAsWord,SaveAsExcel,Preview,Print,SaveAsHtml; InStrXmlData: InStream; FileName: Text)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Update calling code to use the function with an OutStream parameter","tag":"15.3"},"range":"17","first":17,"last":17,"obsoleteSince":17,"spans":[{"from":17,"to":17,"named":"(ReportID: Integer; ReportAction: Option SaveAsPdf,SaveAsWord,SaveAsExcel,Preview,Print,SaveAsHtml; InStrXmlData: InStream; FileName: Text)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Update calling code to use the function with an OutStream parameter","tag":"15.3"}}]},{"name":"MergeWordLayout","sig":"(Integer, Option, InStream, Text, var OutStream)","named":"(ReportID: Integer; ReportAction: Option SaveAsPdf,SaveAsWord,SaveAsExcel,Preview,Print,SaveAsHtml; InStrXmlData: InStream; FileName: Text; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This procedure will be replaced by the report event CustomDocumentMerger. Subscribe to it to override the merging behavior.","tag":"20.0"},"range":"17-22","first":17,"last":22,"obsoleteSince":20,"spans":[{"from":17,"to":19,"named":"(ReportID: Integer; ReportAction: Option SaveAsPdf,SaveAsWord,SaveAsExcel,Preview,Print,SaveAsHtml; InStrXmlData: InStream; FileName: Text; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":20,"to":22,"named":"(ReportID: Integer; ReportAction: Option SaveAsPdf,SaveAsWord,SaveAsExcel,Preview,Print,SaveAsHtml; InStrXmlData: InStream; FileName: Text; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This procedure will be replaced by the report event CustomDocumentMerger. Subscribe to it to override the merging behavior.","tag":"20.0"}}]},{"name":"TryXmlMergeWordDocument","sig":"(var InStream, var InStream, var OutStream)","named":"(var InStrWordDoc: InStream; var InStrXmlData: InStream; var OutStrWordDoc: OutStream)","returns":"Boolean","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"The rendering of Word documents will be handled on the Platform. To override the behavior, subscribe on the report event CustomDocumentMerger.","tag":"20.0"},"range":"17-22","first":17,"last":22,"obsoleteSince":20,"spans":[{"from":17,"to":19,"named":"(var InStrWordDoc: InStream; var InStrXmlData: InStream; var OutStrWordDoc: OutStream)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null},{"from":20,"to":22,"named":"(var InStrWordDoc: InStream; var InStrXmlData: InStream; var OutStrWordDoc: OutStream)","returns":"Boolean","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"The rendering of Word documents will be handled on the Platform. To override the behavior, subscribe on the report event CustomDocumentMerger.","tag":"20.0"}}]},{"name":"ValidateWordLayout","sig":"(Integer, InStream, Boolean, Boolean)","named":"(ReportID: Integer; DocumentStream: InStream; useConfirm: Boolean; updateContext: Boolean)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(ReportID: Integer; DocumentStream: InStream; useConfirm: Boolean; updateContext: Boolean)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"TryUpdateWordLayout","sig":"(InStream, var OutStream, Text, Text)","named":"(DocumentStream: InStream; var UpdateStream: OutStream; CachedCustomPart: Text; CurrentCustomPart: Text)","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(DocumentStream: InStream; var UpdateStream: OutStream; CachedCustomPart: Text; CurrentCustomPart: Text)","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"TryUpdateRdlcLayout","sig":"(Integer, InStream, OutStream, Text, Text, Boolean)","named":"(reportId: Integer; RdlcStream: InStream; RdlcUpdatedStream: OutStream; CachedCustomPart: Text; CurrentCustomPart: Text; IgnoreDelete: Boolean)","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(reportId: Integer; RdlcStream: InStream; RdlcUpdatedStream: OutStream; CachedCustomPart: Text; CurrentCustomPart: Text; IgnoreDelete: Boolean)","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"NewWordLayout","sig":"(Integer, var OutStream)","named":"(ReportId: Integer; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(ReportId: Integer; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ConvertWordToPdf","sig":"(var Codeunit Temp Blob, Integer)","named":"(var TempBlob: Codeunit \"Temp Blob\"; ReportID: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(var TempBlob: Codeunit \"Temp Blob\"; ReportID: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ConvertWordToHtml","sig":"(var Codeunit Temp Blob)","named":"(var TempBlob: Codeunit \"Temp Blob\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(var TempBlob: Codeunit \"Temp Blob\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"IsStreamHasDataset","sig":"(InStream)","named":"(InStrXmlData: InStream)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(InStrXmlData: InStream)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"ApplyUpgradeToReports","sig":"(var DotNet ReportUpgradeCollection, Boolean)","named":"(var ReportUpgradeCollection: DotNet ReportUpgradeCollection; testOnly: Boolean)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(var ReportUpgradeCollection: DotNet ReportUpgradeCollection; testOnly: Boolean)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"CalculateUpgradeChangeSet","sig":"(var DotNet ReportUpgradeCollection)","named":"(var ReportUpgradeCollection: DotNet ReportUpgradeCollection)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"The upgrade will be handled by the platform.","tag":"20.0"},"range":"17-22","first":17,"last":22,"obsoleteSince":20,"spans":[{"from":17,"to":19,"named":"(var ReportUpgradeCollection: DotNet ReportUpgradeCollection)","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":20,"to":22,"named":"(var ReportUpgradeCollection: DotNet ReportUpgradeCollection)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"The upgrade will be handled by the platform.","tag":"20.0"}}]},{"name":"BulkUpgrade","sig":"(Boolean)","named":"(testMode: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"17-29","first":17,"last":29,"obsoleteSince":null,"spans":[{"from":17,"to":29,"named":"(testMode: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetWordLayoutStream","sig":"(Integer, var OutStream, var Boolean)","named":"(ReportID: Integer; var LayoutStream: OutStream; var Success: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This procedure will be eventually replaced by platform functionality. Subscribe to the event FetchReportLayoutByCode instead.","tag":"20.0"},"range":"20-22","first":20,"last":22,"obsoleteSince":20,"spans":[{"from":20,"to":22,"named":"(ReportID: Integer; var LayoutStream: OutStream; var Success: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"This procedure will be eventually replaced by platform functionality. Subscribe to the event FetchReportLayoutByCode instead.","tag":"20.0"}}]},{"name":"NewRdlcLayout","sig":"(Integer, var OutStream)","named":"(ReportId: Integer; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(ReportId: Integer; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"NewExcelLayout","sig":"(Integer, var OutStream)","named":"(ReportId: Integer; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(ReportId: Integer; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"NewExcelLayout","sig":"(Integer, Enum Excel Sheet Configuration, var OutStream)","named":"(ReportId: Integer; ExcelSheetConfiguration: Enum \"Excel Sheet Configuration\"; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(ReportId: Integer; ExcelSheetConfiguration: Enum \"Excel Sheet Configuration\"; var DocumentStream: OutStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]}]}