IUpdateSurfacesCmdArgs

Enumerations

UpdateSurfaceBehavior

Surface insertion mode.

Remarks

You can use this structure in Product.updateSurfaces|updateSurfaces.

Enumeration Members

Enumeration Member	Value	Description
changeSurfaceLength	"changeSurfaceLength"	First deletes all the surfaces of the loaded product and then takes the pages from the new product.
keepCurrentSurfaceLength	"keepCurrentSurfaceLength"	The number of pages remains the same, and the sizes of the surfaces and newProductSurfaces arrays must match.

Interfaces

ISetPrintAreasOptions

Extended by

• IUpdateSurfaceOptions

Properties

clearRemovedItems?

optional clearRemovedItems?: boolean;

If true, clears user-deleted items after merging

preserveSafetyLines?

optional preserveSafetyLines?: boolean;

If true, the current safety lines, if any, are restored in new print areas. If false, safety lines from new print areas are applied. The default value is true.

preserveUserChanges?

optional preserveUserChanges?: boolean;

If true, the changes made by a user are restored in the new print areas or surfaces if it is possible. Otherwise, all changes made by the user are wiped. The default value is true.

replaceAll?

optional replaceAll?: boolean;

If true, design elements whose names do not match move to the new print area in a random order according to their types. If false, only design elements with the same names are moved to the new print area. The default value is false.

updateSurfaceSize?

optional updateSurfaceSize?: boolean;

If true, changes the surface size to match the new print area or surface. If it's false and a mockup is defined, then the surface size remains unchanged. By default, updateSurfaceSize is false, and the surface size changes only if no mockups are specified.

---

IUpdateSurfaceOptions

Extends

• ISetPrintAreasOptions

Type Parameters

Type Parameter
TProduct

Properties

clearRemovedItems?

optional clearRemovedItems?: boolean;

If true, clears user-deleted items after merging

Inherited from

ISetPrintAreasOptions.clearRemovedItems

newProductSurfaces?

optional newProductSurfaces?: number[];

An array of surfaces in the new product to be inserted.

preserveSafetyLines?

optional preserveSafetyLines?: boolean;

If true, the current safety lines, if any, are restored in new print areas. If false, safety lines from new print areas are applied. The default value is true.

Inherited from

ISetPrintAreasOptions.preserveSafetyLines

preserveUserChanges?

optional preserveUserChanges?: boolean;

If true, the changes made by a user are restored in the new print areas or surfaces if it is possible. Otherwise, all changes made by the user are wiped. The default value is true.

Inherited from

ISetPrintAreasOptions.preserveUserChanges

product

product: TProduct;

replaceAll?

optional replaceAll?: boolean;

If true, design elements whose names do not match move to the new print area in a random order according to their types. If false, only design elements with the same names are moved to the new print area. The default value is false.

Inherited from

ISetPrintAreasOptions.replaceAll

surfaces?

optional surfaces?: number[];

An array of surfaces in the current product to be removed.

updateBehavior?

optional updateBehavior?: UpdateSurfaceBehavior;

Defines how new surfaces will replace existing surfaces in the product. If changeSurfaceLength, removes all pages in the product and replaces them with pages of the new product.

updateSurfaceSize?

optional updateSurfaceSize?: boolean;

If true, changes the surface size to match the new print area or surface. If it's false and a mockup is defined, then the surface size remains unchanged. By default, updateSurfaceSize is false, and the surface size changes only if no mockups are specified.

Inherited from

ISetPrintAreasOptions.updateSurfaceSize