Skip to content
API referenceDevelopmentEditor scriptingEngine ccf7d03f
Synced
  • Defines one path-addressed Settings page or one custom-drawn Settings field.

API: scripting
Inherits: object
Project: Inno.Editor.Settings
Scope: Editor

public abstract class InnoEditor.Settings.EditorSetting
Kind Element Description
Constructors EditorSetting.Constructor Creates a Settings definition. A field supplies its persisted default through P:InnoEditor.Settings.EditorSetting.defaultValue; a page keeps the base implementation.
Methods EditorSetting.Draw Draws this field inside the frontend-managed content container.
Methods EditorSetting.IsDefault Determines whether a staged field object equals this definition’s bound default value.
Methods EditorSetting.OnDraw Draws the field using the staged JSON object owned by the Settings frontend. A type that does not override this method describes a page.
Properties EditorSetting.defaultValue Creates the default object for a field. Page definitions keep the base implementation, whose internal value is null.
Properties EditorSetting.description Gets the page or field explanation displayed by the Settings frontend.
Properties EditorSetting.hasValue Gets whether this definition owns one persisted JSON object.
Properties EditorSetting.label Gets the display label derived from the final path segment.
Properties EditorSetting.order Gets the stable order among fields with the same section and label.
Properties EditorSetting.pagePath Gets the page that owns this field, or this page’s own path for a page definition.
Properties EditorSetting.path Gets the complete slash-delimited identity and placement path.
Properties EditorSetting.section Gets the section heading used to group fields alphabetically. Definitions without a section keep the base implementation, whose internal value is null.