---
title: "Editor Class"
canonical: https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.htm
archived: true
applies_to:
  - product: "Customer's Canvas On-Premises"
  - product: "Design Editor"
    versions: ["4.4.25", "4.x (may differ)"]
---

**You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/).

# Editor Class

**Applies to:** Customer's Canvas On-Premises; Design Editor 4.4.25, 4.x (may differ) · **Archived documentation**
 
Represents the web-to-print editor.
  
The interfaces listed below define properties of the objects used as arguments in Customer's Canvas methods
 
## Enumerations
  
|  Name |  Description |
| --- | --- |
 |  [BarcodeFormat](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.barcodeformat.htm.md) |  An enumeration of barcode formats. |
 |  [BarcodeSubType](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.barcodesubtype.htm.md) |  An enumeration of Qr code subtypes. |
 |  [ViolationState](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.violationstate.htm.md) |  An enumeration of preflight check states. |
 
## Interfaces
  
|  Name |  Description |
| --- | --- |
 |  [IBarcodeData](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.ibarcodedata.htm.md) |  A structure containing data that can be encoded into barcodes. |
 |  [IFinishDesignResult](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.ifinishdesignresult.htm.md) |  A structure used by [Editor.finishProductDesign](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.finishproductdesign.htm.md) to store a return value. For details, see the [Introducing the IFrame API](https://customerscanvas.com/docs/cc4/handling-product-customization.htm.md) topic. |
 |  [IProofResult](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.iproofresult.htm.md) |  A structure used by [Editor.getProofImages](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.getproofimages.htm.md) to store a return value. For details, see the [Introducing the IFrame API](https://customerscanvas.com/docs/cc4/handling-product-customization.htm.md) topic. |
 |  [ISaveProductResult](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.isaveproductresult.htm.md) |  A structure used by [Editor.saveProduct](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.saveproduct.htm.md) to store a return value. For details, see the [Introducing the IFrame API](https://customerscanvas.com/docs/cc4/handling-product-customization.htm.md) topic. |
 |  [ISurfaceUserInfo](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.isurfaceuserinfo.htm.md) |  A structure containing user data for a specific product page. |
 |  [ISurfacesChanges](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.isurfaceschanges.htm.md) |  A structure containing changes the user made to the product on a per-surface basis. |
 |  [IUnchangedItem](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.iunchangeditem.htm.md) |  A structure containing a name and a corresponding surface of an unchanged design element. |
 |  [IUnchangedItems](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.iunchangeditems.htm.md) |  A structure used by [Editor.getUnchangedItems](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.getunchangeditems.htm.md) to store a return value. |
 |  [IUserChangeItem](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.iuserchangeitem.htm.md) |  A structure containing a name and a new value of text elements. |
 |  [IUserChanges](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.iuserchanges.htm.md) |  A structure containing all changes the user made to the product when personalizing it. For details, see the [Introducing the IFrame API](https://customerscanvas.com/docs/cc4/handling-product-customization.htm.md) topic. |
 |  [IUserInfo](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.iuserinfo.htm.md) |  A structure containing user data for populating products. For details, see the [Working with User Data](https://customerscanvas.com/docs/cc4/working-with-user-data.htm.md) topic. |
 |  [IValidationResult](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.ivalidationresult.htm.md) |  A structure used by [Editor.validateUserInfo](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.validateuserinfo.htm.md) to store results of the UserInfo validation. |
 |  [IViolationWarningData](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.iviolationwarningdata.htm.md) |  A structure containing details about design elements that have preflight problems. |
 
## Methods
  
|  Name |  Description |
| --- | --- |
 |  [applyProductTheme](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.applyproducttheme.htm.md) |  Applies a color theme to the product. |
 |  [dispose](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.dispose.htm.md) |  Releases all resources used by this Editor. |
 |  [finishProductDesign](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.finishproductdesign.htm.md) |  Saves the current product state and returns links to the hi-res output. For details, see the [Introducing the IFrame API](https://customerscanvas.com/docs/cc4/handling-product-customization.htm.md) topic. |
 |  [getProduct](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.getproduct.htm.md) |  Returns the product currently loaded in the editor. |
 |  [getProofImages](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.getproofimages.htm.md) |  Renders proof images with the optional maximum width and height. For details, see the [Introducing the IFrame API](https://customerscanvas.com/docs/cc4/handling-product-customization.htm.md) topic. |
 |  [getUnchangedItems](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.getunchangeditems.htm.md) |  Returns a list of layers that have not been personalized by the user. These are the items (texts and placeholders) that are not changed when the product editing is finished. |
 |  [loadUserInfo](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.loaduserinfo.htm.md) |  Populates a product with user data. For details, see the [Working with User Data](https://customerscanvas.com/docs/cc4/working-with-user-data.htm.md) topic. |
 |  [redo](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.redo.htm.md) |  Recovers the last user action on the canvas, which was reverted by the **undo** command/button. |
 |  [revertProduct](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.revertproduct.htm.md) |  Cancels all changes made by a user. |
 |  [saveProduct](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.saveproduct.htm.md) |  Saves a product current state. For details, see the [Introducing the IFrame API](https://customerscanvas.com/docs/cc4/handling-product-customization.htm.md) topic. |
 |  [subscribe](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.subscribe.htm.md) |  Links an event with a handler function. [PostMessage.Events](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.postmessage.events.htm.md) object contains the supported events. |
 |  [undo](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.undo.htm.md) |  Reverts the last user action on the canvas. |
 |  [validateUserInfo](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.validateuserinfo.htm.md) |  Validates the [UserInfo](https://customerscanvas.com/docs/cc4/customerscanvas.iframeapi.editor.loaduserinfo.htm.md) structure. |