---
title: "MES Document Editor"
id: "mes-document-editor"
project: "MES User Manual"
url: "https://docs.sepasoft.com/articles/user-manual/mes-document-editor"
updated: 2026-07-31T14:58:54Z
---

# MES Document Editor

**Sepasoft MES Module Suite**
 ### Document Editor

A component that is used to edit HTML documents for use in the manufacturing environment. It functions as a text editor to create and maintain user-interactive documentation, such as instructions for assembly workers, warning notes and data-entry forms for record keeping. Documents are stored as Artifacts on MES Objects (e.g. Material Definitions, Process Segments).

Refer to [Creating and Editing MES Documents](/articles/user-manual/Creating-and-Editing-MES-Documents) for information on creating HTML documentation using this component.
![](/resources/Storage/user-manual/mes-document-editor/MES%20Document%20Editor.PNG)

![](/resources/Storage/user-manual/mes-document-editor/MES%20DM%20-%20Palette%20-%20MES%20Document%20Editor.PNG)

**Component Palette**
 * * *
 #### Component Properties

Properties are provided that can be set to affect the operation and look of the component. They can be set through the **Property Editor in the Designer** or through scripting.

Example

Code

```
event.source.parent.getComponent('MES Document Editor').visible = True
```


![](/resources/Storage/user-manual/mes-document-editor/MES%20Document%20Editor%20-%20Properties.PNG)
 Data
| Name | Scripting | Property Type | Description |
| --- | --- | --- | --- |
| Show HTML Source Editor? | showSourceEditor | boolean | If true, HTML Source Editor will be enabled and the **HTML Source** tab will be available at the bottom of the component. |
| Show HTML Preview Mode? | showPreviewMode | boolean | If true, HTML Preview will be enabled and the **Page Preview** tab will be available at the bottom of the component. |
| Allow Creation of New Artifacts? | allowCreationOfNewArtifacts | boolean | If true, the **Create New Artifact** (![](/resources/Storage/user-manual/mes-document-editor/doc%20mgmt%20new%20artifact%20icon_32x32.png)) button appears in the Tool Bar to allow users to create a new document Artifact on the selected MES Object. |
| Selected MES Object | selectedMESObject | MESObjectLink | MES Object to load document from and store document to. |
| Artifact Name | artifactName | String | The name of the artifact to load document from and store document to. |
 * * *
 Event Handlers

Event handlers provide the ability to add custom script when a user interacts with a component and a component property changes.

propertyChange
propertyChange
Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

| Property | Description |
| --- | --- |
| .source | The component that fired this event. |
| .newValue | The new value that this property changed to. |
| .oldValue | The value that this property was before it changed. Note that not all components include an accurate oldValue in their events. |
| .propertyName | The name of the property that changed. NOTE: Remember to always filter out these events for the property that you are looking for! Components often have many properties that change. |

![](/resources/Storage/user-manual/mes-document-editor/MES%20Document%20Editor%20-%20Event%20Handlers.PNG)
 * * *
 #### Extension Functions

This component does not have extension functions associated with it.

* * *
 Custom Methods

Custom methods allow you to add your own component functions to a component that can be called through scripting. This is a useful and clean method of re-using script that is specific to the component (say you want to update a visual aspect of the component in the same way whether a user clicks on the component or a window property value changes). See Component Custom Methods in the Ignition Help Manual for more information.

![](/resources/Storage/user-manual/mes-document-editor/MES%20Document%20Component%20-%20Custom%20Methods.PNG)
 * * *
 Customizers

The custom properties can be used to add user defined properties.
 * * *
 ### Component Functions

This component does not have functions associated with it.
 
**Sepasoft MES Module Suite**