Overlay
- Class Name:
- com::liquent::insight::manager::publisher::data::overlays::Overlay
| Field Name | Field Type | Matching UI Field | Req(Y/N) | Description | Acceptable Values | Default Value |
|---|---|---|---|---|---|---|
| autofitFlag | string | Scale Content to Margins | N | Scales the content to the margins defined for the overlay. |
|
N |
| bestfitFlag | string | Apply Best Fit Overlay | N | Used to find the best fitting overlay page from the overlay template. |
|
N |
| changeReasonComment | string | N | This field is not used for import. | |||
| changeReasonTypeId | long | N | This field is not used for import. | |||
| id | long | Y | The unique Overlay ID represented by a numerical value. This value will be used to populate corresponding fields in child classes. This ID will be replaced by the database ID in the imported assembly. | |||
| landscapeMarginBottom | long | Landscape Margin Bottom | N | Defines the size of the bottom margin on landscape pages. | See Explanation for Overlay Class Fields. | |
| landscapeMarginLeft | long | Landscape Margin Left | N | Defines the size of the left margin on landscape pages. | See Explanation for Overlay Class Fields. | |
| landscapeMarginRight | long | Landscape Margin Right | N | Defines the size of the right margin on landscape pages. | See Explanation for Overlay Class Fields. | |
| landscapeMarginTop | long | Landscape Margin Top | N | Defines the size of the top margin on landscape pages. | See Explanation for Overlay Class Fields. | |
| measurementTypeId | long | Measurement Unit | N | Defines the measurement unit to be used for the margins. |
|
INCHES |
| name | string | Name | Y | A unique name for the Overlay. | ||
| portraitMarginBottom | long | Portrait Margin Bottom | N | Defines the size of the bottom margin on portrait pages. | See . | |
| portraitMarginLeft | long | Portrait Margin Left | N | Defines the size of the left margin on portrait pages. | See Explanation for Overlay Class Fields. | |
| portraitMarginRight | long | Portrait Margin Right | N | Defines the size of the right margin on portrait pages. | See Explanation for Overlay Class Fields . | |
| portraitMarginTop | long | Portrait Margin Top | N | Defines the size of the top margin on portrait pages. | See Explanation for Overlay Class Fields. | |
| publishingSettingsLibraryId | long | Publishing Settings Library | Y | Value of ID field of PublishingSettingsLibrary class. | Example:
370515 |
|
| refNotFoundText | string | N | This field is not used for import. | |||
| rotateOverlayFlag | string | Rotate Overlay to Content | N | Rotates the overlay to fit the content correctly. |
|
N |
| scaleOverlayFlag | string | Scale Overlay to Content Page Size | N | Scales the overlay to fit the content correctly. |
|
N |
| srcNameOverlay | string | Overlay Template File | N | A link to the document to use to define the Overlay. No template has to be defined, this will effectively be a blank overlay if there is nothing defined. | Example:
//root/folder/file |