{"title":"Codeunit 3110 PDF Document, procedures","url":"https://jonas-paprotka.de/ref/codeunit/3110-pdf-document/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":3110,"name":"PDF Document","app":"System Application","versions":"26-29","url":"https://jonas-paprotka.de/ref/codeunit/3110-pdf-document/","json":"https://jonas-paprotka.de/ref/codeunit/3110-pdf-document.json"},"aspect":"procedures","total":18,"rows":[{"name":"Initialize","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"Load","sig":"(InStream)","named":"(DocumentStream: InStream)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(DocumentStream: InStream)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"ConvertToImage","sig":"(var InStream, Enum Image Format, Integer)","named":"(var ImageStream: InStream; ImageFormat: Enum \"Image Format\"; PageNumber: Integer)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the ConvertPdfToImage procedure instead.","tag":"27.2"},"range":"26-29","first":26,"last":29,"obsoleteSince":27,"spans":[{"from":26,"to":26,"named":"(var ImageStream: InStream; ImageFormat: Enum \"Image Format\"; PageNumber: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null},{"from":27,"to":29,"named":"(var ImageStream: InStream; ImageFormat: Enum \"Image Format\"; PageNumber: Integer)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use the ConvertPdfToImage procedure instead.","tag":"27.2"}}]},{"name":"GetDocumentAttachmentStream","sig":"(InStream, var Codeunit Temp Blob)","named":"(PdfStream: InStream; var TempBlob: Codeunit \"Temp Blob\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(PdfStream: InStream; var TempBlob: Codeunit \"Temp Blob\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetPdfProperties","sig":"(InStream)","named":"(DocumentInStream: InStream)","returns":"JsonObject","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(DocumentInStream: InStream)","returns":"JsonObject","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetPdfPageCount","sig":"(InStream)","named":"(DocumentInStream: InStream)","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(DocumentInStream: InStream)","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetZipArchive","sig":"(InStream)","named":"(PdfStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(PdfStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetAttachmentNames","sig":"(InStream)","named":"(PdfStream: InStream)","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(PdfStream: InStream)","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddAttachment","sig":"(Text, Enum PDF Attach. Data Relationship, Text, Text, Text, Boolean)","named":"(AttachmentName: Text; PDFAttachmentDataType: Enum \"PDF Attach. Data Relationship\"; MimeType: Text; FileName: Text; Description: Text; PrimaryDocument: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(AttachmentName: Text; PDFAttachmentDataType: Enum \"PDF Attach. Data Relationship\"; MimeType: Text; FileName: Text; Description: Text; PrimaryDocument: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddFileToAppend","sig":"(Text)","named":"(FileName: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(FileName: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddStreamToAppend","sig":"(InStream)","named":"(FileInStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(FileInStream: InStream)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ProtectDocument","sig":"(Text, Text)","named":"(User: Text; Admin: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(User: Text; Admin: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ProtectDocument","sig":"(SecretText, SecretText)","named":"(User: SecretText; Admin: SecretText)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(User: SecretText; Admin: SecretText)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AttachmentCount","sig":"()","named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"AppendedDocumentCount","sig":"()","named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"ToJson","sig":"(JsonObject)","named":"(RenderingPayload: JsonObject)","returns":"JsonObject","kind":"procedure","access":"public","obsolete":null,"range":"26-29","first":26,"last":29,"obsoleteSince":null,"spans":[{"from":26,"to":29,"named":"(RenderingPayload: JsonObject)","returns":"JsonObject","kind":"procedure","access":"public","obsolete":null}]},{"name":"ConvertPdfToImage","sig":"(var InStream, Enum Image Format, Integer)","named":"(var ImageStream: InStream; ImageFormat: Enum \"Image Format\"; PageNumber: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var ImageStream: InStream; ImageFormat: Enum \"Image Format\"; PageNumber: Integer)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddAttachment","sig":"(Text, Enum PDF Attach. Data Relationship, Text, InStream, Text, Boolean)","named":"(AttachmentName: Text; PDFAttachmentDataType: Enum \"PDF Attach. Data Relationship\"; MimeType: Text; FileInStream: InStream; Description: Text; PrimaryDocument: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(AttachmentName: Text; PDFAttachmentDataType: Enum \"PDF Attach. Data Relationship\"; MimeType: Text; FileInStream: InStream; Description: Text; PrimaryDocument: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]}]}