Skip to content

KVSKBADocDispSingleInstance#

Procedures#

Summary: Sets whether to print the report with logo.

procedure SetPrintWithLogo(NewPrintWithLogo: Boolean):

Parameters:

  • NewPrintWithLogo: Boolean value indicating if report should be printed with logo

Summary: Gets the current print with logo setting.

procedure GetPrintWithLogo(): Boolean

Returns: Boolean indicating if report should be printed with logo

SetPostAndPrint(Boolean) :#

Summary: Sets whether to post and print the document.

procedure SetPostAndPrint(NewPostAndPrint: Boolean):

Parameters:

  • NewPostAndPrint: Boolean value indicating if document should be posted and printed

GetPostAndPrint() : Boolean#

Summary: Gets the current post and print setting.

procedure GetPostAndPrint(): Boolean

Returns: Boolean indicating if document should be posted and printed

SetOutputMode(Enum KVSKBAOutputMode) :#

Summary: Sets the output mode for document processing.

procedure SetOutputMode(NewOutputMode: Enum "KVSKBAOutputMode"):

Parameters:

  • NewOutputMode: Output mode enum value (Default, Preview, SystemPrinter, PrinterSelection, PDF, Word, Excel, XML, HTML)

GetOutputMode() : Enum#

Summary: Gets the current output mode setting.

procedure GetOutputMode(): Enum KVSKBAOutputMode

Returns: Current output mode enum value

GetDefaultOutputMode(Boolean, Integer) : Enum#

Obsolete

This Element will be removed or changed with a future Version of the App.

Summary: Determines the default output mode based on GUI availability and report ID.

[Obsolete('Use GetDefaultOutputMode without ReportID instead, because ReportID is not used.', '27.1')]
procedure GetDefaultOutputMode(IsGUI: Boolean; ReportID: Integer): Enum KVSKBAOutputMode

Parameters:

  • IsGUI: Boolean indicating if GUI is available
  • ReportID: Report ID for which to determine default output mode

Returns: Default output mode - PDF for non-GUI environments, Default for GUI environments

GetDefaultOutputMode(Boolean) : Enum#

Summary: Determines the default output mode based on GUI availability and report ID.

procedure GetDefaultOutputMode(IsGUIPar: Boolean): Enum KVSKBAOutputMode

Parameters:

  • IsGUIPar: Boolean indicating if GUI is available

Returns: Default output mode - PDF for non-GUI environments, Default for GUI environments

SetOutputFileName(Text[250]) :#

Summary: Sets the output file name for document generation.

procedure SetOutputFileName(NewOutputFileName: Text[250]):

Parameters:

  • NewOutputFileName: File name for the output document (max 250 characters)

GetOutputFileName() : Text[250]#

Summary: Gets the current output file name setting.

procedure GetOutputFileName(): Text[250]

Returns: Current output file name (max 250 characters)

SetRequestPageParams(Text) :#

Summary: Sets the request page parameters for report processing.

procedure SetRequestPageParams(NewRequestPageParams: Text):

Parameters:

  • NewRequestPageParams: Request page parameters as text

GetRequestPageParams() : Text#

Summary: Gets the current request page parameters.

procedure GetRequestPageParams(): Text

Returns: Current request page parameters as text

GetRequestPage() : Boolean#

Summary: Gets the current request page setting.

procedure GetRequestPage(): Boolean

Returns: Boolean indicating if request page should be shown

SetRequestPage(Boolean) :#

Summary: Sets whether to show the request page.

procedure SetRequestPage(UseRequestPage: Boolean):

Parameters:

  • UseRequestPage: Boolean indicating if request page should be shown

SetRequestPageAlreadyOpen(Boolean) :#

Summary: Sets whether the request page is already open.

procedure SetRequestPageAlreadyOpen(NewRequestPageAlreadyOpen: Boolean):

Parameters:

  • NewRequestPageAlreadyOpen: Boolean indicating if request page is already open

GetRequestPageAlreadyOpen() : Boolean#

Summary: Gets whether the request page is already open.

procedure GetRequestPageAlreadyOpen(): Boolean

Returns: Boolean indicating if request page is already open

SetOutputOptions(Boolean, Boolean, Enum KVSKBAOutputMode, Text[250]) :#

Summary: Sets multiple output options in one call with automatic mode adjustment.

procedure SetOutputOptions(NewPrintWithLogo: Boolean; NewRequestPage: Boolean; NewOutputMode: Enum "KVSKBAOutputMode"; NewOutputFileName: Text[250]):

Parameters:

  • NewPrintWithLogo: Boolean indicating if report should be printed with logo
  • NewRequestPage: Boolean indicating if request page should be shown
  • NewOutputMode: Output mode enum value
  • NewOutputFileName: File name for the output document

Remarks: Automatically sets output mode to PDF if Default mode is selected without request page

ResetOutputOptions() :#

Summary: Resets all output options to their default values.

procedure ResetOutputOptions():

Remarks: Sets RequestPage to true, OutputMode to Default, and clears all file names and parameters

SetClientReportID(Integer) :#

Summary: Sets the client report ID for report processing.

procedure SetClientReportID(NewClientReportID: Integer):

Parameters:

  • NewClientReportID: Integer value representing the client report ID

SetRequestPageOnly(Boolean) :#

Summary: Sets whether to show only the request page without processing.

procedure SetRequestPageOnly(NewRequestPageOnly: Boolean):

Parameters:

  • NewRequestPageOnly: Boolean indicating if only request page should be shown

GetRequestPageOnly() : Boolean#

Summary: Gets whether only the request page should be shown.

procedure GetRequestPageOnly(): Boolean

Returns: Boolean indicating if only request page should be shown

SetLayoutDebuggingMode(Integer) :#

Summary: Sets the layout debugging mode for report development.

procedure SetLayoutDebuggingMode(NewDebuggingMode: Integer):

Parameters:

  • NewDebuggingMode: Integer value representing the debugging mode level

GetLayoutDebuggingMode() : Integer#

Summary: Gets the current layout debugging mode setting.

procedure GetLayoutDebuggingMode(): Integer

Returns: Integer value of the current debugging mode level