OLECMDID

The OLECMDID enumeration specifies which command to execute. (The commands in this enumeration are the standard commands defined by Office 95.) A single value from this enumeration is passed in the nCmdID argument of IOleCommandTarget::Exec.

typedef enum  
{ 
     OLECMDID_OPEN              = 1, 
     OLECMDID_NEW               = 2, 
     OLECMDID_SAVE              = 3, 
     OLECMDID_SAVEAS            = 4, 
     OLECMDID_SAVECOPYAS        = 5, 
     OLECMDID_PRINT             = 6, 
     OLECMDID_PRINTPREVIEW      = 7, 
     OLECMDID_PAGESETUP         = 8, 
     OLECMDID_SPELL             = 9, 
     OLECMDID_PROPERTIES        = 10, 
     OLECMDID_CUT               = 11, 
     OLECMDID_COPY              = 12, 
     OLECMDID_PASTE             = 13, 
     OLECMDID_PASTESPECIAL      = 14, 
     OLECMDID_UNDO              = 15, 
     OLECMDID_REDO              = 16, 
     OLECMDID_SELECTALL         = 17, 
     OLECMDID_CLEARSELECTION    = 18, 
     OLECMDID_ZOOM              = 19, 
     OLECMDID_GETZOOMRANGE      = 20 
     OLECMDID_UPDATECOMMANDS    = 21 
     OLECMDID_REFRESH           = 22 
     OLECMDID_STOP              = 23 
     OLECMDID_HIDETOOLBARS      = 24 
     OLECMDID_SETPROGRESSMAX    = 25 
     OLECMDID_SETPROGRESSPOS    = 26 
     OLECMDID_SETPROGRESSTEXT   = 27 
     OLECMDID_SETTITLE          = 28 
     OLECMDID_SETDOWNLOADSTATE  = 29 
     OLECMDID_STOPDOWNLOAD      = 30 
} OLECMDID;

Elements

OLECMDID_OPEN: File menu, Open command
OLECMDID_NEW: File menu, New command
OLECMDID_SAVE: File menu, Save command
OLECMDID_SAVEAS: File menu, Save As command
OLECMDID_SAVECOPYAS: File menu, Save Copy As command
OLECMDID_PRINT: File menu, Print command
OLECMDID_PRINTPREVIEW: File menu, Print Preview command
OLECMDID_PAGESETUP: File menu, Page Setup command
OLECMDID_SPELL: Tools menu, Spelling command
OLECMDID_PROPERTIES: File menu, Properties command
OLECMDID_CUT: Edit menu, Cut command
OLECMDID_COPY: Edit menu, Copy command
OLECMDID_PASTE: Edit menu, Paste command
OLECMDID_PASTESPECIAL: Edit menu, Paste Special command
OLECMDID_UNDO: Edit menu, Undo command
OLECMDID_REDO: Edit menu, Redo command
OLECMDID_SELECTALL: Edit menu, Select All command
OLECMDID_CLEARSELECTION: Edit menu, Clear command
OLECMDID_ZOOM: View menu, Zoom command (see below for details)
OLECMDID_GETZOOMRANGE: Retrieves zoom range applicable to View Zoom. (See below for details.)
OLECMDID_UPDATECOMMANDS: Informs the receiver, usually a frame, of state changes. The receiver can then query the status of the commands whenever convenient.
OLECMDID_REFRESH: Asks the receiver to refresh its display. Implemented by the document/object.
OLECMDID_STOP: Stops all current processing. Implemented by the document/object.
OLECMDID_HIDETOOLBARS: View Menu, Toolbars command. Implemented by the document/object to hide its toolbars.
OLECMDID_SETPROGRESSMAX: Sets the maximum value of a progress indicator if one is owned by the receiving object, usually a frame. The minimum value is always zero.
OLECMDID_SETPROGRESSPOS: Sets the current value of a progress indicator if one is owned by the receiving object, usually a frame.
OLECMDID_SETPROGRESSTEXT: Sets the text contained in a progress indicator if one is owned by the receiving object, usually a frame. If the receiver currently has no progress indicator, this text should be displayed in the status bar (if one exists) as with IOleInPlaceFrame::SetStatusText.
OLECMDID_SETTITLE: Sets the title bar text of the receiving object, usually a frame.
OLECMDID_SETDOWNLOADSTATE: Called by the object when downloading state changes. Takes a VT_BOOL parameter, which is TRUE if the object is downloading data and FALSE if it not. Primarily implemented by the frame.
OLECMDID_STOPDOWNLOAD: Stops the download when executed. Typically, this command is propagated to all contained objects. When queried, sets MSOCMDF_ENABLED. Implemented by the document/object.

Remarks

In OLE Compound Documents technology, an object that is being edited in-place disables the Zoom control on its toolbar and the Zoom command on its View menu, because, the Zoom command applies logically to the container document, not to the object. The OLECMDID_ZOOM and OLECMDID_GETZOOMRANGE commands notify the container's frame object of the zoom range it should use to display a document object in its user interface. The container frame is the client-side object that implements IOleInPlaceFrame and, optionally, IOleCommandTarget.

The OLECMDID_ZOOM command takes one LONG argument as input and writes one LONG argument on output. This command is used for three purposes:

To query the current zoom value. The caller of IOleCommandTarget::Exec passes OLECMDEXECOPT_DONTPROMPTUSER as the execute option in nCmdExecOpt and NULL for pvIn. The object returns the current zoom value in pvaOut. When the object goes UI active, it retrieves the current zoom value from the container's frame object using this same mechanism and updates its zoom control with the returned value.
To display the Zoom dialog box. The caller of IOleCommandTarget::Exec passes OLECMDEXECOPT_PROMPTUSER in nCmdExecOpt. The caller can optionally pass the initial value for the dialog box through pvaIn; otherwise pvaIn must be NULL. If the user clicks Cancel, the object returns OLECMDERR_E_CANCELED. If the user clicks OK, the object passes the user-selected value in pvaOut. When user chooses the Zoom command from the View menu, the object calls the container's frame object in the same manner. The container then zooms the document to the user selected value, and the object updates its Zoom control with that value.
To set a Zoom value. The caller of IOleCommandTarget::Exec passes OLECMDEXECOPT_DONTPROMPTUSER in nCmdExecOpt and passes the zoom value to apply through pvaIn. The object validates and normalizes the new value and returns the validated value in pvaOut. When the user selects a new zoom value (using the Zoom control on the toolbar, for instance), the object calls the container's frame object in this manner. The container zooms the document to 100 percent, and the object updates the Zoom control with that value.

The OLECMDID_GETZOOMRANGE command is used to determine the range of valid zoom values from an object that implements IOleCommandTarget. The caller passes MSOCMDEXECOPT_DONTPROMPTUSER in nCmdExecOpt and NULL for pvaIn. The object returns its zoom range as a DWORD in pvaOut where the HIWORD contains the maximum zoom value and the LOWORD contains the minimum zoom value. Typically this command is used when the user drops down the Zoom control on the toolbar of the UI-active object. The applications and objects that support this command are required to support all the integral zoom values that are within the (min,max) pair they return.

OLECMDID

Elements

Remarks

See Also