MKI_INSERTBLOCK_DATA (Basic Classes) Changed in Version 2024.0

C++ Syntax

class MKI_INSERTBLOCK_DATA

{

  public:

  MKI_LIBRARYNAME m_szLibraryName;

  MKI_BLOCKNAME m_szBlockName;

  MKI_COMMENTLONG m_szComment;

  double m_dScale,

         m_dRotate;

  __int32 m_nMode,

          m_nDisplayMode;

  MKI_INSERTBLOCK_DATA( void );

  void

  Init( void );

};

This structure contains input/output data for the "insert block" dialog (see MKI_DialogInsertBlock).

Element Description

LibraryName Changed in Version 2019.1

[MKI_LIBRARYNAME] Name of the currently selected library.

BlockName Changed in Version 2019.1

[MKI_BLOCKNAME] Name of the currently selected block.

Comment Changed in Version 2019.1

[MKI_COMMENTLONG] Comment for the instance to be created.

Scale

[double] Corresponds to the "Scaling" edit box of the dialog.

Rotate

[double] Corresponds to the "Rotation" edit box of the dialog.

Mode Changed in Version 2024.0

[__int32] Bit-wise OR combination of some flags indicating various modes. Possible values are:

MODE_SHOW_ATTRIBUTES

Corresponds to the "Show attributes" check box of the dialog.

MODE_SHOW_PREVIEW

Corresponds to the "Display preview" check box of the dialog.

MODE_SHOW_NOVARIABLES

Corresponds to the "Do not resolve" (variables, attributes, and text statements) check box of the dialog.

MODE_TRANSMIT_LAYER

Corresponds to the "Transmit instance layer to block" check box of the dialog.

MODE_USE_BLOCK_LAYER

Corresponds to the "Apply block layer to instance" check box of the dialog.

MODE_TRANSMIT_PEN

Corresponds to the "Transmit instance pen to block" check box of the dialog.

MODE_USE_BLOCK_PEN

Corresponds to the "Apply block pen to instance" check box of the dialog.

MODE_COPY_ATTRIBUTES

Corresponds to the "Use local attributes" check box of the dialog.

MODE_EDIT_ATTRIBUTES

Corresponds to the "Edit local attributes" check box of the dialog.

MODE_COPY_COMMENT

Corresponds to the "Copy block's comment" check box of the dialog.

MODE_ADAPT_SCALE

Corresponds to the "Retain block scale" check box of the dialog.

MODE_MANUAL_ROTATE

Corresponds to the "Rotate manually" check box of the dialog.

MODE_RESOLVE

Corresponds to the "Resolve block immediately" check box of the dialog.

MODE_GROUPED

Corresponds to the "... into nested groups" check box of the dialog.

MODE_CONVERT

Corresponds to the "Convert to internal block" check box of the dialog.

DisplayMode

[__int32] A bit-wise OR combination of the following values (see MKI_DISPLAYMODE_*):

MKI_DISPLAYMODE_SCALED_WIDTH

Corresponds to the "Scale line widths" check box of the dialog.

MKI_DISPLAYMODE_CONFINED

Corresponds to the "Use only elements from library" check box of the dialog.

MKI_DISPLAYMODE_NOGEO

Corresponds to the "Don't display construction aid" check box of the dialog.

MKI_DISPLAYMODE_ADAPT_ANGLE Renamed in Version 2017.0

Corresponds to the "Adapt rotation to page / mapping" check box of the dialog.

MKI_DISPLAYMODE_SCALED_LENGTH New in Version 2010.2

Corresponds to the "Scale line type lengths" check box of the dialog.

MKI_DISPLAYMODE_EMBEDDED New in Version 2012.0

Corresponds to the "Create embedded block" check box of the dialog.

MKI_DISPLAYMODE_ADAPT_SCALE New in Version 2017.0

Corresponds to the "Adapt scaling to page / mapping" check box of the dialog.

Comment

When calling MKI_DialogInsertBlock(), use the following flags defined in this class to enable the individual controls:

DIALOGMODE_LIBRARY

If this flag is set, changing LibraryName will be allowed. Otherwise, the user cannot change the library name!

DIALOGMODE_SCALE

If this flag is set, the controls corresponding to the Scale element will be visible and enabled.

DIALOGMODE_ROTATE

If this flag is set, the controls corresponding to the Rotate element will be visible and enabled.

DIALOGMODE_TRANSMITLAYER

If this flag is set, the control corresponding to the TransmitLayer element will be visible and enabled.

DIALOGMODE_USEBLOCKLAYER

If this flag is set, the control corresponding to the UseBlockLayer element will be visible and enabled.

DIALOGMODE_TRANSMITPEN

If this flag is set, the control corresponding to the TransmitPen element will be visible and enabled.

DIALOGMODE_USEBLOCKPEN

If this flag is set, the control corresponding to the UseBlockPen element will be visible and enabled.

DIALOGMODE_COPYATTRIB

If this flag is set, the control corresponding to the CopyAttributes element will be visible and enabled.

DIALOGMODE_EDITATTRIB

If this flag is set, the control corresponding to the EditAttributes element will be visible and enabled.

DIALOGMODE_USEBLOCKSCALE

If this flag is set, the control corresponding to the UseBlockScale element will be visible and enabled.

DIALOGMODE_RESOLVE

If this flag is set, the control corresponding to the Resolve element will be visible and enabled.

DIALOGMODE_DISPLAY_SCALED

If this flag is set, the controls corresponding to the MKI_DISPLAYMODE_SCALED_WIDTH and MKI_DISPLAYMODE_SCALED_LENGTH bits of the DisplayMode element will be visible and enabled.

DIALOGMODE_DISPLAY_NOGEO

If this flag is set, the controls corresponding to the MKI_DISPLAYMODE_NOGEO bit of the DisplayMode element will be visible and enabled.

DIALOGMODE_DISPLAY_CONFINED

If this flag is set, the controls corresponding to the MKI_DISPLAYMODE_CONFINED bit of the DisplayMode element will be visible and enabled.

DIALOGMODE_DISPLAY_ADAPT Renamed in Version 2017.0

If this flag is set, the controls corresponding to the MKI_DISPLAYMODE_ADAPT_ANGLE and MKI_DISPLAYMODE_ADAPT_SCALE bits of the DisplayMode element will be visible and enabled.

DIALOGMODE_DISPLAY_EMBEDDED

If this flag is set, the controls corresponding to the MKI_DISPLAYMODE_EMBEDDED bit of the DisplayMode element will be visible and enabled.

DIALOGMODE_DISPLAY_NOHIDE

If this flag is set, the controls corresponding to the MKI_DISPLAYMODE_NOHIDE bit of the DisplayMode element will be visible and enabled.

DIALOGMODE_EMBED New in Version 2023.2

If this flag is set, the controls corresponding to the MKI_DISPLAYMODE_EMBEDDED bit of the DisplayMode element will be visible and enabled.

DIALOGMODE_CONVERT New in Version 2023.2

If this flag is set, the controls corresponding to the Convert element will be visible and enabled.

DIALOGMODE_COMMENT New in Version 2013.0

If this flag is set, the controls corresponding to the Comment element will be visible and enabled.