Class AcApOpenCmd

Command to open a CAD file.

This command triggers the file opening workflow by emitting an 'open-file' event on the global event bus. The actual file opening logic is handled by other components listening for this event (typically the UI layer).

The command follows the standard CAD pattern where the command itself is lightweight and delegates the actual work to specialized handlers.

Example

const openCommand = new AcApOpenCmd();
openCommand.globalName = 'OPEN';
openCommand.localName = 'Open File';

// Trigger the command
openCommand.trigger(docManager.context);

// The command will emit 'open-file' event for UI components to handle

Hierarchy (View Summary)

Constructors

constructor

Properties

events

Accessors

globalName localName

Methods

execute tirgger

Constructors

constructor

Properties

Readonlyevents

events: {
    commandEnded: AcCmEventManager<AcEdCommandEventArgs>;
    commandWillStart: AcCmEventManager<AcEdCommandEventArgs>;
} = ...

Events fired during command execution lifecycle

Type declaration

Accessors

globalName

  • get globalName(): string

    Gets the global (untranslated) name of the command.

    The global name is typically used for programmatic access and should remain consistent across different language localizations.

    Returns string

    The global command name

  • set globalName(value: string): void

    Sets the global (untranslated) name of the command.

    Parameters

    • value: string

      The global command name (e.g., 'LINE', 'CIRCLE', 'ZOOM')

    Returns void

localName

  • get localName(): string

    Gets the local (translated) name of the command.

    The local name is displayed to users and should be localized to the current language/region.

    Returns string

    The localized command name

  • set localName(value: string): void

    Sets the local (translated) name of the command.

    Parameters

    • value: string

      The localized command name (e.g., 'Draw Line', 'Zoom In')

    Returns void

Methods

execute

  • execute(_context: AcApContext): void

    Executes the open file command.

    Emits an 'open-file' event on the global event bus to trigger the file opening workflow. UI components typically listen for this event to display file selection dialogs.

    Parameters

    • _context: AcApContext

      The current application context (not used in this command)

    Returns void

tirgger

  • tirgger(context: AcApContext): void

    Triggers the command execution with proper event handling.

    This method should not be overridden by subclasses as it handles the event notification workflow. Subclasses should implement the execute() method instead.

    The execution flow:

    1. Fires commandWillStart event
    2. Calls the execute() method
    3. Fires commandEnded event

    Parameters

    • context: AcApContext

      The current application context containing view and document

    Returns void

    Example

    const command = new MyCommand();
    command.trigger(docManager.context);

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods