Systems.Documents.PrintoutLayouts Entity
Namespace: Systems.Documents
Contains design layouts for document printouts. Entity: Gen_Printout_Layouts
Renames
Old name: General.PrintoutLayouts
New name: Systems.Documents.PrintoutLayouts
Version: 24.1.5.35
Case: 35911
Default Visualization
Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault
Track Changes
Min level: 4 - Track object attribute and blob changes
Max level: 4 - Track object attribute and blob changes
Aggregate
An aggregate is a cluster of domain objects that can be treated as a single unit.
Aggregate Tree
Attributes
Name | Type | Description |
---|---|---|
BinaryLayout | byte[] nullable | The printout layout, when the format requires binary storage. Alternative to Layout. |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
DocumentEntityName | string (64) | The entity name of the document type e.g. Crm_Sales_Orders, Inv_Store_Orders etc. Required Filter(eq) |
Id | guid | |
Layout | string (max) nullable | The textual representation of the printout layout, when the format requires text representation. Alternative to Binary_Layout. |
LayoutFormat | string (32) | Format specifier of the layout. Recognized by the application. Required Filter(multi eq) |
Name | string (64) | The name of this PrintoutLayout. Required Filter(eq;like) ORD |
Notes | string (254) nullable | Notes for this PrintoutLayout. |
ObjectVersion | int32 | The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking. |
References
Name | Type | Description |
---|---|---|
DataSource | DataSources (nullable) | The data source for the printout. Filter(multi eq) |
Attribute Details
BinaryLayout
The printout layout, when the format requires binary storage. Alternative to Layout.
Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: CannotBeShown
DisplayText
Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
DocumentEntityName
The entity name of the document type e.g. Crm_Sales_Orders, Inv_Store_Orders etc. Required
Filter(eq)
Type: string (64)
Category: System
Supported Filters: Equals
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown
Layout
The textual representation of the printout layout, when the format requires text representation. Alternative to Binary_Layout.
Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault
LayoutFormat
Format specifier of the layout. Recognized by the application. Required
Filter(multi eq)
Type: string (32)
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Maximum Length: 32
Show in UI: CannotBeShown
Name
The name of this PrintoutLayout. Required
Filter(eq;like)
ORD
Type: string (64)
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 64
Show in UI: ShownByDefault
Front-End Recalc Expressions:
IIF( Not( IsNullOrEmpty( obj.DocumentEntityName)), obj.GetDefaultName( ), null)
Notes
Notes for this PrintoutLayout.
Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: HiddenByDefault
ObjectVersion
The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault
Reference Details
DataSource
The data source for the printout. Filter(multi eq)
Type: DataSources (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault
API Methods
Methods that can be invoked in public APIs.
GetAllowedCustomPropertyValues
Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET
Parameters
customPropertyCode
The code of the custom property
Type: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0
CreateNotification
Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST
Parameters
user
The user.
Type: UsersnotificationClass
The notification class.
Type: stringsubject
The notification subject.
Type: string
CreateCopy
Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST
Business Rules
None
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_Documents_PrintoutLayouts?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_Documents_PrintoutLayouts?$top=10