BINDF [Beta]
Values from the BINDF enumeration are returned to the binding layer from the client's IBindStatusCallback::OnStartBinding . These values are used to identify what type of binding the client wants from the moniker.
typedef enum {
BINDF_ASYNCHRONOUS,
BINDF_NOPROGRESSIVERENDERING,
BINDF_ASYNCSTORAGE,
BINDF_OFFLINEOPERATION,
BINDF_DONTUSECACHE,
BINDF_DONTPUTINCACHE,
BINDF_GETDATAONDEMAND
} BINDF;
Members
BINDF_ASYNCHRONOUS
The moniker should return immediately from IMoniker::BindToStorage or IMoniker::BindToObject. The actual result of the object bind or the data backing the storage will arrive asynchronously.
BINDF_NOPROGRESSIVERENDERING
The client requires a single call to IBindStatusCallback::OnDataAvailable with grfBSCF set to BSCF_FIRSTDATANOTIFICATION | BSCF_LASTDATANOTIFICATION and the actual data/object. The client is essentially not interested in intermediary data availability.
BINDF_ASYNCSTORAGE
The client prefers IStorage and IStream objects returned from IMoniker::BindToStorage which return E_PENDING when they reference data not yet available through I/O methods, rather than blocking until the data becomes available.
BINDF_OFFLINEOPERATION
Even if necessary network resources are not available, the bind should proceed in offline operation using cached information.
BINDF_DONTUSECACHE
The moniker bind operation should not read from the disk cache when retrieving data.
BINDF_DONTPUTINCACHE
The moniker bind operation should not store retrieved data in the disk cache.
BINDF_GETDATAONDEMAND
Do not start the bind operation immediately. If this
flag is specified for an asynchronous BindToStorage operation,
the IBindStatusCallback::OnDataAvailable
notification will be called instantly, returning an asynchronous
stream of data. Downloading of data will only begin when the client
begins reading from this stream.
See Also
IBindStatusCallback::OnStartBinding
BINDINFOF [Beta]
Values from the BINDINFOF enumeration are passed to the client within IBindStatusCallback::GetBindInfo to specify additional flags for the bind operation.
typedef enum {
BINDINFOF_URLENCODESTGMEDDATA,
BINDINFOF_URLENCODEDEXTRAINFO,
} BINDINFOF;
Members
BINDINFOF_URLENCODESTGMEDDATA
Use URL encoding to pass is the data provided in the stgmedData member of the BINDINFO. (for PUT and POST operations).
BINDINFOF_URLENCODEEXTRAINFO
Use URL encoding to pass is the data provided in
the szExtraInfo member of the BINDINFO.
See Also
IBindStatusCallback::GetBindInfo
BINDSTATUS [Beta]
A single value from the BINDSTATUS enumeration is passed as ulStatusCode to the IBindStatusCallback::OnProgress function to tell the client about the progress of the bind operation.
typedef enum tagBINDSTATUS {
BINDSTATUS_FINDINGRESOURCE,
BINDSTATUS_CONNECTING,
BINDSTATUS_REDIRECTING,
BINDSTATUS_BEGINDOWNLOADDATA,
BINDSTATUS_DOWNLOADINGDATA,
BINDSTATUS_ENDDOWNLOADDATA,
BINDSTATUS_BEGINDOWNLOADCOMPONENTS,
BINDSTATUS_INSTALLINGCOMPONENTS,
BINDSTATUS_ENDDOWNLOADCOMPONENTS,
BINDSTATUS_OBJECTAVAILABLE
} BINDSTATUS;
Members
BINDSTATUS_FINDINGRESOURCE
The bind operation is finding the resource that holds the object or storage being bound to. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the resource being searched for (for example, "www.microsoft.com").
BINDSTATUS_CONNECTING
The bind operation is connecting to the resource that holds the object or storage being bound to. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the resource being connected to (for example,. "www.microsoft.com").
BINDSTATUS_REDIRECTING
The bind operation has been redirected to a different data location. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the new data location.
BINDSTATUS_BEGINDOWNLOADDATA
The bind operation has begun receiving the object or storage being bound to. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the data location.
BINDSTATUS_DOWNLOADINGDATA
The bind operation continues to receive the object or storage being bound to. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the data location.
BINDSTATUS_ENDDOWNLOADDATA
The bind operation has finished receiving the object or storage being bound to. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the data location.
BINDSTATUS_BEGINDOWNLOADCOMPONENTS
For BindToObject operations only - the bind operation has begun downloading code for OLE components that will be installed before the object may be instantiated. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the component being downloaded.
BINDSTATUS_INSTALLINGCOMPONENTS
For BindToObject operations only - the bind operation has downloaded code and is installing it before object instantiation. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the component being installed.
BINDSTATUS_ENDDOWNLOADCOMPONENTS
For BindToObject operations only - the bind operation has finished downloading and installing all necessary code. The szStatusText accompanying IBindStatusCallback::OnProgress provides the display name of the newly installed component.
BINDSTATUS_OBJECTAVAILABLE
For BindToObject operations only - the object
has been instantiated and an interface pointer is available.
This status code allows clients to discover when the object is
available even if they do not receive the IBindStatusCallback::OnObjectAvailable
notification. The szStatusText accompanying IBindStatusCallback::OnProgress
is NULL.
See Also
IBindStatusCallback::OnProgress
BINDVERB [Beta]
Values from the BINDVERB enumeration are passed to the client within IBindStatusCallback::GetBindInfo to distinguish different types of bind operations.
typedef enum {
BINDVERB_GET,
BINDVERB_POST,
BINDVERB_PUT,
BINDVERB_CUSTOM
} BINDVERB;
Members
BINDVERB_GET
Perform a "get" operation (the default). The stgmedData member of the BINDINFO should be set to TYMED_NULL.
BINDVERB_POST
Perform a "post" operation. The data to post should be specified in the stgmedData member of the BINDINFO.
BINDVERB_PUT
Perform a "put" operation. The data to put should be specified in the stgmedData member of the BINDINFO.
BINDVERB_CUSTOM
Perform a custom operation (protocol specific, see
szCustomVerb member of BINDINFO). The data to use should
be specified in the stgmedData member of the BINDINFO.
See Also
IBindStatusCallback::GetBindInfo
BSCF [Beta]
Values from the BSCF enumeration are passed to the client in IBindStatusCallback::OnDataAvailable to clarify the type of data that is available.
typedef enum tagBSCF {
BSCF_FIRSTDATANOTIFICATION,
BSCF_LASTDATANOTIFICATION,
BSCF_INTERMEDIARYDATANOTIFICATION
} BSCF;
Members
BSCF_FIRSTDATANOTIFICATION
Identifies the first call to IBindStatusCallback::OnDataAvailable for a given bind operation.
BSCF_LASTDATANOTIFICATION
Identifies the last call to IBindStatusCallback::OnDataAvailable for a bind operation.
BSCF_INTERMEDIARYDATANOTIFICATION
Identifies an intermediary call to IBindStatusCallback::OnDataAvailable
for a bind operation.
See Also
IBindStatusCallback::OnDataAvailable
BSCO_OPTION [Beta]
Values from the BSCO_OPTION enumeration are passed into a call to the RegisterBindStatusCallback function when registering a callback for a bind operation. These values are used to identify the type of binding callback notification the client wants from the moniker. Simple clients of IMoniker::BindToStorage that want nothing but the data bits need specify only BSCO_ONDATAAVAILABLE.
typedef enum {
BSCO_ONSTARTBINDING,
BSCO_GETPRIORITY,
BSCO_ONLOWRESOURCE,
BSCO_ONPROGRESS,
BSCO_ONSTOPBINDING,
BSCO_GETBINDINFO,
BSCO_ONDATAAVAILABLE,
BSCO_ONOBJECTAVAILABLE,
BSCO_ALLONIBSC
} BSCO_OPTION;
Members
BSCO_ONSTARTBINDING
The client would like to receive the OnStartBinding callback.
BSCO_GETPRIORITY
The client would like to receive the GetPriority callback.
BSCO_ONLOWRESOURCE
The client would like to receive the OnLowResource callback.
BSCO_ONPROGRESS
The client would like to receive the OnProgress callback.
BSCO_ONSTOPBINDING
The client would like to receive the OnStopBinding callback.
BSCO_ONGETBINDINFO
The client would like to receive the OnGetBindInfo callback.
BSCO_ONDATAAVAILABLE
The client would like to receive the OnDataAvailable callback.
BSCO_ONOBJECTAVAILABLE
The client would like to receive the OnObjectAvailable callback.
BSCO_ALLONIBSC
The client would like to receive all callbacks.
See Also
DOCMISC [Beta]
The DOCMISC enumeration provides miscellaneous status information about a document object. A combination of values from DOCMISC is returned in pdwStatus in IOleDocument::GetDocMiscStatus .
typedef enum
{
DOCMISC_CANCREATEMULTIPLEVIEWS = 1,
DOCMISC_SUPPORTCOMPLEXRECTANGLES = 2,
DOCMISC_CANTOPENEDIT, = 4,
DOCMISC_NOFILESUPPORT = 8
} DOCMISC;
Members
DOCMISC_CANCREATEMULTIPLEVIEWS
Object supports multiple views.
DOCMISC_SUPPORTCOMPLEXRECTANGLES
Object supports complex rectangles and, therefore, IOleDocumentView::SetRectComplex .
DOCMISC_CANTOPENEDIT
Object supports activation in a separate windows and, therefore, IOleDocumentView::Open .
DOCMISC_NOFILESUPPORT
Object does not support file read/write.
Remarks
Objects that have a limited user interface for activation purposes should set DOCMISC_CANTOPENEDIT. Those that only support IPersistStorage as a persistence mechanism should specify DOCMISC_NOFILESUPPORT. Otherwise, an object must also implement IPersistFile.
If an object desires none of these status bits it must return a zero in the *pdwStatus parameter of IOleDocument::GetDocMiscStatus.
See Also
IOleDocument::GetDocMiscStatus , IOleDocumentView::Open , IOleDocumentView::SetRectComplex , IPersistFile, IPersistStorage
GUIDKIND [Beta]
The GUIDKIND enumeration values are flags used to specify the kind of information requested from an object in the IProvideClassInfo2 and IProvideClassInfo3 interfaces.
typedef enum tagGUIDKIND
{
GUIDKIND_DEFAULT_SOURCE_DISP_IID = 1,
GUIDKIND_DEFAULT_SOURCE_IID = 2,
GUIDKIND_DEFAULT_DISP_IID = 3,
GUIDKIND_DEFAULT_IID = 4,
GUIDKIND_TLBID = 5,
GUIDKIND_CLSID = 6
} GUIDKIND;
Members
GUIDKIND_DEFAULT_SOURCE_DISP_IID
The interface identifier (IID) of the object's outgoing dispinterface, labeled [source, default]. The outgoing interface in question must be derived from IDispatch.
GUIDKIND_DEFAULT_SOURCE_IID
The interface identifier (IID) of the object's outgoing interface, labeled [source, default]. The outgoing interface can be any COM interface.
GUIDKIND_DEFAULT_DISP_IID
The interface identifier (IID) of the object's [default] dispinterface that best represents the object as a whole. This dispinterface must be derived from IDispatch..
GUIDKIND_DEFAULT_IID
The interface identifier (IID) of the object's [default] interface that best represents the object as a whole. This interface can be any COM interface.
GUIDKIND_TLBID
The GUID identifying the object's current type library.
GUIDKIND_CLSID
The object's CLSID.
Remarks
Any object implementing IProvideClassInfo3 should support at least GUIDKIND_DEFAULT_IID through this method.
See Also
IProvideClassInfo2 , IProvideClassInfo3
HLBWIF [Beta]
The HLBWIF enumeration contains values relating to the locations and sizes of frame- and document-level windows within a browse context. The HLBWINFO structure is retrieved from the browse context using IHlinkBrowseContext::GetBrowseWindowInfo , and put into the browse context using IHlinkBrowseContext::SetBrowseWindowInfo . Hyperlink targets retrieve the HLBWINFO structure during IHlinkTarget::Navigate in order to reposition their user interface properly and ensure as seamless a transition as possible to the new document or object.
typedef enum tagHLBWIF
{
HLBWIF_HASFRAMEWNDINFO,
HLBWIF_HASDOCWNDINFO,
HLBWIF_FRAMEWNDMAXIMIZED,
HLBWIF_DOCWNDMAXIMIZED
} HLBWIF;
Members
HLBWIF_HASFRAMEWNDINFO
This browse context has available frame-level window positioning information.
HLBWIF_HASDOCWNDINFO
This browse context has available document-level window positioning information.
HLBWIF_FRAMEWNDMAXIMIZED
Only useful in combination with HLBWIF_HASFRAMEWNDINFO. Indicates that frame-level windows of the browse context should appear maximized.
HLBWIF_DOCWNDMAXIMIZED
Only useful in combination with HLBWIF_HASDOCWNDINFO.
Indicates that document-level windows of the browse context should
appear maximized.
See Also
HLBWINFO , IHlinkBrowseContext::GetBrowseWindowInfo , IHlinkBrowseContext::SetBrowseWindowInfo
HLFNAMEF [Beta]
The HLFNAMEF enumeration constants specify which friendly name a client is requesting. These flags are used by the IHlink::GetFriendlyName interface.
typedef enum tagHLFNAMEF
{
HLFNAMEF_DEFAULT,
HLFNAMEF_TRYCACHE,
HLFNAMEF_TRYPRETTYTARGET,
HLFNAMEF_TRYFULLTARGET,
HLFNAMEF_TRYWIN95SHORTCUT
} HLFNAMEF ;
Members
HLFNAMEF_DEFAULT
HLFNAMEF_TRYCACHE
HLFNAMEF_TRYPRETTYTARGET
HLFNAMEF_TRYFULLTARGET
HLFNAMEF_TRYWIN95SHORTCUT
See Also
HLID [Beta]
The HLID enumeration constants identify the logical positions of a hyperlink identifier in the a hyperlink navigation stack. These constants are used in the IHlinkBrowseContext interface.
typedef enum tagHLID
{
HLID_PREVIOUS,
HLID_NEXT,
HLID_CURRENT,
HLID_STACKBOTTOM,
HLID_STACKTOP
} HLID;
Members
HLID_PREVIOUS
The hyperlink prior to the current one. If the current hyperlink is the first or only hyperlink in the navigation stack, or if there are no hyperlinks in the navigation stack, there is no previous hyperlink, and methods such as IHlinkBrowseContext::GetHlink will return NULL and E_FAIL when passed this value.
HLID_NEXT
The hyperlink after the current one. If the current hyperlink is the last or only hyperlink in the navigation stack, or if there are no hyperlinks in the navigation stack, there is no next hyperlink, and methods such as IHlinkBrowseContext::GetHlink will return NULL and E_FAIL when passed this value.
HLID_CURRENT
The current hyperlink. A browsing tool might offer a command to reload the current page, or to re-center the user interface around the beginning portion of the current hyperlink destination, or to restart animation, sound, or other activity by re-navigating to the current hyperlink.
HLID_STACKBOTTOM
The very first hyperlink in the navigation stack. If there are no hyperlinks in the navigation stack, there is no stack-bottom hyperlink, and methods such as IHlinkBrowseContext::GetHlink will return NULL and E_FAIL when passed this value.
HLID_STACKTOP
The very last hyperlink in the navigation stack.
If there are no hyperlinks in the navigation stack, there is no
stack-top hyperlink, and methods such as IHlinkBrowseContext::GetHlink
will return NULL and E_FAIL when passed this value.
Remarks
For convenience and performance, individual hyperlink objects are often identified in a navigation stack like a browse context or a history/favorites list using a ULONG hyperlink identifier or HLID rather than an IHlink interface pointer. This prevents unnecessary passing of interface pointers across process boundaries in common user-interface scenarios, such as building a drop-down menu or scrollable list of the history, or when testing the current location in the navigation stack to enable Go Back and Go Forward.
See Also
HLQF , IHlinkBrowseContext::GetHlink , IHlinkBrowseContext::QueryHlink , IHlinkBrowseContext::SetCurrentHlink
HLINKGETREF [Beta]
The HLINKGETREF enumeration constants specify whether the client is requesting the absolute, relative or default reference for the hyperlink target. These constants are used in the IHlink::GetMonikerReference and IHlink::GetStringReference methods.
typedef enum tagHLINKGETREF
{
HLINKGETREF_DEFAULT,
HLINKGETREF_ABSOLUTE,
HLINKGETREF_RELATIVE
} HLINKGETREF ;
Members
HLINKGETREF_DEFAULT
Used to specify that the client of the hyperlink wishes to retrieve the default reference for hyperlink target. This depends on whether the hyperlink was initialized as a relative or an absolute reference.
HLINKGETREF_ABSOLUTE
Used to specify that the client of the hyperlink wishes to retrieve the absolute reference for hyperlink target.
HLINKGETREF_RELATIVE
Used to specify that the client of the hyperlink
wishes to retrieve the relative reference for hyperlink target.
See Also
IHlink::GetMonikerReference , IHlink::GetStringReference
HLINKMISC [Beta]
The HLINKMISC enumeration constants specify whether the hyperlink object is a relative or an absolute hyperlink to its target. These constants are used in the IHlink::GetMiscStatus method.
typedef enum tagHLINKMISC
{
HLINKMISC_ABSOLUTE,
HLINKMISC_RELATIVE
} HLINKMISC ;
Members
HLINKMISC_ABSOLUTE
The given hyperlink object contains an absolute reference to the hyperlink target.
HLINKMISC_RELATIVE
The given hyperlink object contains a relative reference
to the hyperlink target.
See Also
HLINKWHICHMK [Beta]
The HLINKWHICHMK enumeration constants specify whether a moniker being requested is the moniker for the container document or a base moniker specific to a hyperlink site. These constants are used in the IHlinkSite::GetMoniker method.
typedef enum tagHLINKWHICHMK
{
HLINKWHICHMK_CONTAINER,
HLINKWHICHMK_BASE
} HLINKWHICHMK ;
Members
HLINKWHICHMK_CONTAINER
Used to specify that the hyperlink wishes to retrieve the moniker for the hyperlink container corresponding to a particular hyperlink site.
HLINKWHICHMK_BASE
Used to specify that the hyperlink wishes to request
the base moniker corresponding to the particular hyperlink site.
(These may be different, for example, if a
See Also
HLNF [Beta]
Values from the HLNF enumeration are used to indicate how the hyperlink navigation is to proceed, and also convey contextual information about the navigation from each of the objects participating in the navigation protocol to the others. These constants are used in the IHlink , IHlinkBrowseContext , IHlinkFrame , and IHlinkTarget interfaces and in the HlinkNavigateToStringReference , HlinkOnNavigate , HlinkSimpleNavigateToMoniker , and HlinkSimpleNavigateToString API functions.
typedef enum tagHLNF
{
HLNF_INTERNALJUMP = 1,
HLNF_NAVIGATINGBACK = 2,
HLNF_NAVIGATINGFORWARD = 4,
HLNF_USEBROWSECONTEXTCLONE = 8,
HLNF_OFFSETWINDOWORG = 16,
HLNF_OPENINNEWWINDOW = 24,
// (HLNF_USEBROWSECONTEXTCLONE | HLNF_OFFSETWINDOWORG),
HLNF_CREATENOHISTORY = 32,
HLNF_NAVIGATINGTOSTACKITEM = 64
} HLNF;
Members
HLNF_INTERNALJUMP
The navigation is an internal jump within the current hyperlink target. The system provided hyperlink object adds this flag to the grfHLNF passed to its IHlink::Navigate prior to calling IHlinkTarget::Navigate when it determines that its relative moniker is NULL. Sending this flag on to the hyperlink target allows the target to exclude any expensive operations and avoid spurious repainting during IHlinkTarget::Navigate.
HLNF_NAVIGATINGBACK
The navigation is occurring due to the Go Back command, in which case no history should be created in the browse context, and the current position in the navigation stack should be moved back one element. Hyperlink frames and hyperlink containers send this flag to IHlink::Navigate for their Go Back command.
HLNF_NAVIGATINGFORWARD
The navigation is occurring due to the Go Forward command, in which case no history should be created in the browse context, and the current position in the navigation stack should be moved forward one element. Hyperlink frames and hyperlink containers send this flag to IHlink::Navigate for their Go Forward command.
HLNF_USEBROWSECONTEXTCLONE
When called in IHlink::Navigate, the passed in IHlinkBrowseContext should be immediately cloned (via IHlinkBrowseContext::Clone ) and used for all subsequent browse context calls and parameters to other methods.
HLNF_OFFSETWINDOWORG
Indicates that the hyperlink target should offset its frame- and/or document-level window(s) from the position returned in the HLBWINFO structure by IHlinkBrowseContext::GetBrowseWindowInfo during IHlinkTarget::Navigate. This flag is often passed in conjunction with HLNF_USEBROWSECONTEXTCLONE to implement an Open in New Window command.
HLNF_OPENINNEWWINDOW
An abbreviation for two commonly coincident options: HLNF_USEBROWSECONTEXTCLONE and HLNF_OFFSETWINDOWORG.
HLNF_CREATENOHISTORY
Indicates that the browse context should not during IHlinkBrowseContext::OnNavigateHlink add this hyperlink to the navigation stack.
HLNF_NAVIGATINGTOSTACKITEM
Indicates that the browse context should not during
IHlinkBrowseContext::OnNavigateHlink add this hyperlink
to the navigation stack, and further that it should update its
current position to reflect that this hyperlink is the current
hyperlink. This flag is used when, for example, the user selects
a particular hyperlink from the navigation stack -
the user should navigate to the location, but the jump should
not be recorded in the navigation stack, and the availability
of the Go Forward and Go Back commands should be
reevaluated.
See Also
IHlink::Navigate , IHlinkFrame::Navigate , IHlinkFrame::OnNavigate , IHlinkTarget::Navigate , IHlinkBrowseContext::OnNavigateHlink , HlinkNavigateToStringReference , HlinkOnNavigate , HlinkSimpleNavigateToMoniker , HlinkSimpleNavigateToString
HLQF [Beta]
The HLQF enumeration constants specify query flags used by IHlinkBrowseContext::QueryHlink to determine the state of a particular hyperlink.
typedef enum tagHLQF
{
HLQF_ISVALID = 1,
HLQF_ISCURRENT = 2
} HLQF;
Members
HLQF_ISVALID
Tests the validity of a particular hyperlink. The uHLID parameter may specify either a specific hyperlink within the navigation stack or a relative hyperlink, such as HLID_NEXT or HLID_PREVIOUS.
HLQF_ISCURRENT
Tests if the specific hyperlink (identified by the
uHLID parameter) is the user's current position within the navigation
stack.
See Also
HLID , IHlinkBrowseContext::QueryHlink
HLSR [Beta]
The HLSR enumeration constants specify which of the special hyperlink references to choose. These constants are used by the HlinkGetSpecialReference and HlinkSetSpecialReference API functions.
typedef enum tagHLSR
{
HLSR_HOME,
HLSR_SEARCHPAGE,
HLSR_HISTORYFOLDER
} HLSR ;
Members
HLSR_HOME
Specifies the hyperlink reference to the global user "home" page.
HLSR_SEARCHPAGE
Specifies the hyperlink reference to the global user "search page."
HLSR_HISTORYFOLDER
Specifies the hyperlink reference to the global user
"history folder" page.
See Also
HlinkGetSpecialReference , HlinkSetSpecialReference
INTERNETFLAG [Beta]
The INTERNETFLAG enumeration values are flags used to specify one of the GUID groups in the IProvideClassInfo3::GetFlags method. There is only one bit flag currently defined for the INTERNETFLAG group.
typedef enum tagINTERNETFLAG
{
INTERNETFLAG_USESDATAPATHS = 0x00000001
} INTERNETFLAG;
Members
INTERNETFLAG_USESDATAPATHS
Specifies that the object uses one or more data path
properties to manage BLOB data storage.
OLECMDF [Beta]
Designates the type of support provided by an object for the command specified in OLECMD .
typedef enum
{
OLECMDF_SUPPORTED = 1,
OLECMDF_ENABLED = 2,
OLECMDF_LATCHED = 4,
OLECMDF_NINCHED = 8
} OLECMDF;
Members
OLECMDF_SUPPORTED
The command is supported by this object.
OLECMDF_ENABLED
The command is available and enabled.
OLECMDF_LATCHED
The command is an on-off toggle and is currently on.
OLECMDF_NINCHED
TDB
Remarks
Values from the OLECMDF enumeration are used to fill the value of the cmdf field in OLECMD structures passed to IOleCommandTarget::QueryStatus .
See Also
IOleCommandTarget::QueryStatus , OLECMD , OLECMDF
OLECMDTEXTF [Beta]
Specifies the type of information that an object should store in the OLECMDTEXT structure passed in IOleCommandTarget::QueryStatus . One value from this enumeration is stored the cmdtextf member of the OLECMDTEXT structure to indicate the desired information.
typedef enum
{
OLECMDTEXTF_NONE = 0,
OLECMDTEXTF_NAME = 1,
OLECMDTEXTF_STATUS = 2
} OLECMDTEXTF;
Members
OLECMDTEXTF_NONE
No extra information is requested.
OLECMDTEXTF_NAME
The object should return the localized name of the command.
OLECMDTEXTF_STATUS
The object should return a localized status string
for the command.
See Also
IOleCommandTarget::QueryStatus , OLECMDTEXT
OLECMDEXECOPT [Beta]
Specifies command-execution options. One value from this enumeration is passed in the nCmdExecOpt argument of IOleCommandTarget::Exec .
typedef enum
{
OLECMDEXECOPT_DODEFAULT = 0,
OLECMDEXECOPT_PROMPTUSER = 1,
LECMDEXECOPT_DONTPROMPTUSER = 2,
OLECMDEXECOPT_SHOWHELP = 3
} OLECMDEXECOPT;
Members
OLECMDEXECOPT_PROMPTUSER
Execute the command after taking user input.
OLECMDEXECOPT_DONTPROMPTUSER
Execute the command without prompting the user (for example, clicking on the Print toolbar button, causes the document to be immediately printed without requiring the user input).
OLECMDEXECOPT_DODEFAULT
Caller is not sure whether the user should be prompted or not.
OLECMDEXECOPT_SHOWHELP
Object should show help for the corresponding command
and not execute
See Also
OLECMDID [Beta]
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;
Members
OLECMDID_OPEN
File Open
OLECMDID_NEW
File New
OLECMDID_SAVE
File Save
OLECMDID_SAVEAS
File Save As
OLECMDID_SAVECOPYAS
File Save Copy As
OLECMDID_PRINT
File Print
OLECMDID_PRINTPREVIEW
File Print Preview
OLECMDID_PAGESETUP
File Page Setup
OLECMDID_SPELL
Tools Spelling
OLECMDID_PROPERTIES
File Properties
OLECMDID_CUT
Edit Cut
OLECMDID_COPY
Edit Copy
OLECMDID_PASTE
Edit Paste
OLECMDID_PASTESPECIAL
Edit Paste Special
OLECMDID_UNDO
Edit Undo
OLECMDID_REDO
Edit Redo
OLECMDID_SELECTALL
Edit Select All
OLECMDID_CLEARSELECTION
Edit Clear
OLECMDID_ZOOM
View Zoom (see below for details)
OLECMDID_GETZOOMRANGE
Retrieves zoom range applicable to View Zoom (see
below for details)
Remarks
In OLE 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, logically, the Zoom command applies to the container document , not to the object. Now, in OLE Document Objects technology, the OLECMDID_ZOOM and OLECMDID_GETZOOMRANGE commands provide a document object with a means of notifying the container's frame object of the zoom range that it should display 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 returns one LONG argument on output. This command is used for three purposes:
· To query the current zoom value that the caller passes to 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 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 presses CANCEL, the object returns OLECMDERR_E_CANCELED; if the user presses OK, then the object returns the user selected value in pvaOut. When user selects the View.Zoom menu item, the object calls 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 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 the normalized
value 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.
See Also
IOleCommandTarget , IOleCommandTarget::Exec , IOleInPlaceFrame
PRINTFLAG [Beta]
Specifies printing options. A combination of values from PRINTFLAG is passed in the grfFlags parameter of IPrint::Print .
typedef enum
{
PRINTFLAG_MAYBOTHERUSER = 1,
PRINTFLAG_PROMPTUSER = 2,
PRINTFLAG_USERMAYCHANGEPRINTER = 4,
PRINTFLAG_RECOMPOSETODEVICE = 8,
PRINTFLAG_DONTACTUALLYPRINT = 16,
PRINTFLAG_FORCEPROPERTIES = 32,
PRINTFLAG_PRINTTOFILE = 64
} PRINTFLAG;
Members
PRINTFLAG_MAYBOTHERUSER
User interaction permitted. If this flag is not set, no part of the printing process may interact with the user.
PRINTFLAG_PROMPTUSER
Prompt the user for job-specific printing options, using the normal print dialog for the object. Support for this option is required. Only valid if PRINTFLAG_MAYBOTHERUSER is specified.
PRINTFLAG_USERMAYCHANGEPRINTER
Only valid if PRINTFLAG_PROMPTUSER is specified. Indicates that the user may change the target printer; in the absence of this flag, the user must print on the default printer.
PRINTFLAG_RECOMPOSETODEVICE
The object should attempt to recompose itself to the indicated target device. In the absence of this flag, the object should, if possible, retain any existing compositional-device association that it may have.
PRINTFLAG_DONTACTUALLYPRINT
Carry out actions resulting from user actions or object-recomposition, but don't actually carry out the printing operation.
PRINTFLAG_PRINTTOFILE
Print to the file that is named in the portname
field of DVTARGETDEVICE.
See Also