Skip to content

Codeunit wDCR_LayoutSelectionMgt

A codeunit with procedures for layout selections.

Properties

Name Value
Access Public

Methods

wgFncGetReportLayoutSelection(Integer, Text[30], Guid, Report Layout Selection@, Text[250]@, Guid@, Text[255]@, Boolean@, Boolean@)

Procedure to retrieve the report layout selection for specified report ID, company name and user ID.

Parameters

Type Name Description
Integer pReportID Report Object ID
Text[30] pCompanyName Company Name
Guid pUserID User ID
Record "Report Layout Selection" temporary vRecTempReportLayoutSelection The layout selection.
Text[250] vLayoutName The name of the layout of the layout selection.
Guid vAppID The layout app ID.
Text[255] vMimeType The MIME Type of the layout.
Boolean vIsUserDefined Whether the layout is a user-defined layout.
Boolean vSelectionExists Whether a layout selection exists.

wgFncRemoveReportLayoutSelections(Integer)

Removes the report layout selections for the report object with specified ID, in all companies.

Parameters

Type Name Description
Integer pReportID Report Object ID.

wgFncRemoveReportLayoutSelectionsForCurrentCompany(Integer)

Removes the report layout selections for the report object with specified ID in the current company only.

Parameters

Type Name Description
Integer pReportID Report Object ID.

wgFncRemoveTenantReportLayoutSelections(Report Layout List, Boolean)

Removes all tenant report layout selections for the specified report layout.

Parameters

Type Name Description
Record "Report Layout List" pRecReportLayoutList The report layout.
Boolean pConfirm Whether confirmation from the user is needed.

wgFncRemoveTenantReportLayoutSelections(Integer, Text[250], Guid, Boolean)

Removes all tenant report layout selections for the specified report layout.

Parameters

Type Name Description
Integer pReportID Report Object ID.
Text[250] pLayoutName The name of the layout.
Guid pAppID The layout app ID.
Boolean pConfirm Whether confirmation from the user is needed.

wgFncSelectLayoutsForAllCompanies(Report Layout List@)

Sets up the report layout selections to the specified report layout for all companies. Confirmation from the user is requested.

Parameters

Type Name Description
Record "Report Layout List" vRecReportLayoutList The report layout.

wgFncSelectReportLayout(Integer, Report Layout List@, Boolean):Boolean

Obsolete

Please use WSB_ReportSelectionMgt.wgFncSelectReportLayout from the Apportunix "System Library" extension instead. 2.58.0.0

Opens a page to select a report layout from the "Report Layouts" page.

Parameters

Type Name Description
Integer pReportID The ID of the report object for which to select a layout.
Record "Report Layout List" vRecReportLayoutList The report layout that was selected.
Boolean pForEmailBody Whether to filter the page to only display layouts that can be used as email body.

Returns

Type Description
Boolean true iff a layout was selected on the page (the user selected a layout and pressed OK)

wgFncSetReportLayoutSelection(Report Layout List, Text[30]):Boolean

Sets a report layout selection. Copy of "Report Layouts Impl.".SetDefaultReportLayoutSelection

Parameters

Type Name Description
Record "Report Layout List" pRecSelectedReportLayoutList The report layout.
Text[30] pCompanyName Company name.

Returns

Type Description
Boolean true iff successful.

wgFncSetReportLayoutSelection(Report Layout List, Text[30], Guid):Boolean

Sets a report layout selection. Copy of "Report Layouts Impl.".SetDefaultReportLayoutSelection

Parameters

Type Name Description
Record "Report Layout List" pRecSelectedReportLayoutList The report layout.
Text[30] pCompanyName Company name.
Guid pUserID User ID

Returns

Type Description
Boolean true iff successful.

wgFncSetReportLayoutSelectionForCurrentCompany(Report Layout List):Boolean

Sets a report layout selection for the current company.

Parameters

Type Name Description
Record "Report Layout List" pRecSelectedReportLayoutList The report layout

Returns

Type Description
Boolean true iff successful

wlEvpOnBeforeSelectLayoutsForAllCompanies(Report Layout List@, Boolean@)

Allows to hook into setting a report layout to be used in all companies.

Parameters

Type Name Description
Record "Report Layout List" vRecReportLayoutList The report layout.
Boolean vIsHandled Set this to true if your extension handles setting report layout selections for the report layout.