Functions

Functions

void mdlUndo_endGroup ()
 
The mdlUndo_startGroup and mdlUndo_endGroup functions allow applications to group changes to

the design file so the changes are undone as a unit. More...

 
bool mdlUndo_isActive (WStringP string)
 mdlUndo_isActive returns an indication of whether whether it is possible to execute an UNDO command. More...
 
void mdlUndo_mark ()
 The mdlUndo_mark function sets a mark in the undo buffer. More...
 
void mdlUndo_setActive (bool active)
 Set the active state of the undo buffer. More...
 
bool mdlUndo_redoActive (WStringP string)
 mdlUndo_isActive returns an indication of whether an element is in the undo buffer (whether it is possible to execute an UNDO command). More...
 
void mdlUndo_startGroup ()
 The mdlUndo_startGroup and mdlUndo_endGroup functions let applications group changes to the design file so the groups are undone as a unit. More...
 
void mdlUndo_undoActions (int numActions)
 execute the Undo command to reverse the last "numAction" changes. More...
 
void mdlUndo_redoLastUndo ()
 reverse the last Undo command. More...
 
bool mdlUndo_setViewUndoActive (int viewIndex, bool active)
 Enables or disables the undo function for the specified view. More...
 

Detailed Description

Function Documentation

void mdlUndo_endGroup ( )

The mdlUndo_startGroup and mdlUndo_endGroup functions allow applications to group changes to

the design file so the changes are undone as a unit.

Remarks
The UNDO command undoes all changes to the design file since the last mark in the undo buffer. MicroStation ordinarily sets this mark every time the user enters a data point or starts a new primitive command. Sometimes applications group several changes to the design file. These changes require multiple data points, so that the groups are always undone as a single unit.
Calls to mdlUndo_startGroup can be nested, but should always be matched with a corresponding call to mdlUndo_endGroup.
See also
mdlUndo_mark mdlUndo_endGroup
bool mdlUndo_isActive ( WStringP  string)

mdlUndo_isActive returns an indication of whether whether it is possible to execute an UNDO command.

Parameters
[out]stringcommand to be undone
Remarks
Both functions return a character string in commandString that describes the command to be undone or redone.
Returns
true if an entry exists in their respective buffers and false otherwise.
See also
mdlUndo_redoActive
Remarks
Required Library: mdlbltin.lib
void mdlUndo_mark ( )

The mdlUndo_mark function sets a mark in the undo buffer.

Remarks
The UNDO command undoes all changes to the design file since the last mark in the undo buffer. MicroStation ordinarily sets this mark every time the user enters a data point or starts a new primitive command. MDL applications that create or manipulate elements can break the operations into multiple undoable portions by calling mdlUndo_mark.
With versions 4.0.0 and 4.0.1 of MicroStation, mdlUndo_mark required that an int parameter be passed to it (though it ignored this parameter.) MicroStation versions 4.0.2 and newer no longer require this parameter.
See also
mdlUndo_startGroup mdlUndo_endGroup
Remarks
Required Library: mdlbltin.lib
bool mdlUndo_redoActive ( WStringP  string)

mdlUndo_isActive returns an indication of whether an element is in the undo buffer (whether it is possible to execute an UNDO command).

mdlUndo_redoActive returns an indication of whether there is an element in the redo buffer (whether it is possible to execute a REDO command).

Parameters
[out]stringcommand to be undone
Remarks
Both functions return a character string in commandString that describes the command to be undone or redone.
Returns
true if an entry exists in their respective buffers and false otherwise.
Remarks
Required Library: mdlbltin.lib
void mdlUndo_redoLastUndo ( )

reverse the last Undo command.

Does nothing if the last operation was not an undo.

Remarks
Required Library: mdlbltin.lib
void mdlUndo_setActive ( bool  active)

Set the active state of the undo buffer.

Parameters
[in]activeif false, undo is cleared and temporary file is deleted. If true, an temporary file is created and undo processing begins. If and undo is already active, this will reset all undo pointers (clearing the contents of the undo buffer).
Remarks
Required Library: mdlbltin.lib
bool mdlUndo_setViewUndoActive ( int  viewIndex,
bool  active 
)

Enables or disables the undo function for the specified view.

Parameters
[in]viewIndexthe index of the view to set the Undo function for
[in]activeif true, the Undo function is enabled for the specified view
if false, the Undo function is disabled for the specified view
Returns
the previous setting of the Undo function before this function was called.
Remarks
Required Library: mdlbltin.lib
void mdlUndo_startGroup ( )

The mdlUndo_startGroup and mdlUndo_endGroup functions let applications group changes to the design file so the groups are undone as a unit.

Remarks
The UNDO command undoes all changes to the design file since the last mark in the undo buffer. MicroStation ordinarily sets this mark every time the user enters a data point or starts a new primitive command. Sometimes applications group several changes to the design file. These changes require multiple data points, so that the groups are always undone as a single unit.
Calls to mdlUndo_startGroup can be nested, but should always be matched with a corresponding call to mdlUndo_endGroup.
See also
mdlUndo_mark mdlUndo_endGroup
Remarks
Required Library: mdlbltin.lib
void mdlUndo_undoActions ( int  numActions)

execute the Undo command to reverse the last "numAction" changes.

Parameters
[in]numActionsthe number of actions to undo
Remarks
Required Library: mdlbltin.lib

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.