OLE and Data Transfer Enumerations

Enumerations

ACTIVATEFLAGS
ADVF
DATADIR
DISCARDCACHE
DOCMISC
DROPEFFECT
DVASPECT
DVASPECT2
DVASPECTINFOFLAG
DVEXTENTMODE
HITRESULT
OLECLOSE
OLECMDEXECOPT
OLECMDF
OLECMDID
OLECMDTEXTF
 

OLECONTF
OLECREATE
OLEDCFLAGS
OLEGETMONIKER
OLELINKBIND
OLEMISC
OLERENDER
OLEUIPASTEFLAG
OLEUPDATE
OLEVERBATTRIB
OLEWHICHMK
TYMED
UASFLAGS
USERCLASSTYPE
VIEWSTATUS

ACTIVATEFLAGS

The ACTIVATEFLAGS enumeration value indicates whether an object is activated as a windowless object. It is used in IOleInPlaceSiteEx::OnInPlaceActivateEx.
 

%ACTIVATE_WINDOWLESS = 1
 

ADVF

The ADVF enumeration values are flags used by a container object to specify the requested behavior when setting up an advise sink or a caching connection with an object. These values have different meanings, depending on the type of connection in which they are used, and each interface uses its own subset of the flags.
 

%ADVF_NODATA = 1
%ADVF_PRIMEFIRST = 2
%ADVF_ONLYONCE = 4
%ADVF_DATAONSTOP = 64
%ADVFCACHE_NOHANDLER = 8
%ADVFCACHE_FORCEBUILTIN = 16
%ADVFCACHE_ONSAVE = 32
 

DATADIR

The DATADIR enumeration values specify the direction of the data flow in the dwDirection parameter of the IDataObject::EnumFormatEtc method. This determines the formats that the resulting enumerator can enumerate.

%DATADIR_GET = 1
%DATADIR_SET = 2
 

DISCARDCACHE

The DISCARDCACHE enumeration values are used in the IOleCache2::DiscardCache method to specify what to do with caches that are to be discarded from memory if their dirty bit has been set. The dwDiscardOptions parameter specifies whether or not to save these caches.

%DISCARDCACHE_SAVEIFDIRTY = 0
%DISCARDCACHE_NOSAVE = 1
 

DOCMISC

The DOCMISC enumeration provides miscellaneous property information about a document object. A combination of values from DOCMISC is returned at the location specified by the pdwStatus parameter in IOleDocument::GetDocMiscStatus.

%DOCMISC_CANCREATEMULTIPLEVIEWS = 1
%DOCMISC_SUPPORTCOMPLEXRECTANGLES = 2
%DOCMISC_CANTOPENEDIT = 4
%DOCMISC_NOFILESUPPORT = 8
 

DROPEFFECT

The DoDragDrop function and many of the methods in the IDropSource and IDropTarget interfaces pass information about the effects of a drag-and-drop operation in a DROPEFFECT enumeration.

%DROPEFFECT_NONE = 0
%DROPEFFECT_COPY = 1
%DROPEFFECT_MOVE = 2
%DROPEFFECT_LINK = 4
%DROPEFFECT_SCROLL = &H80000000
 

DVASPECT

The DVASPECT enumeration values specify the desired data or view aspect of the object when drawing or getting data.

%DVASPECT_CONTENT = 1
%DVASPECT_THUMBNAIL = 2
%DVASPECT_ICON = 4
%DVASPECT_DOCPRINT = 8
 

DVASPECT2

The DVASPECT2 enumeration value is used in IViewObject::Draw to specify new drawing aspects used to optimize the drawing process.

%DVASPECT_OPAQUE = 16
%DVASPECT_TRANSPARENT = 32
 

DVASPECTINFOFLAG

The DVASPECTINFOFLAG enumeration value is used in the DVASPECTINFO structure to indicate whether an object can support optimized drawing of itself.

%DVASPECTINFOFLAG_CANOPTIMIZE = 1
 

DVEXTENTMODE

The DVEXTENTMODE enumeration values are used in IViewObjectEx::GetNaturalExtent.

%DVEXTENT_CONTENT = 0
%DVEXTENT_INTEGRAL = 1
 

HITRESULT

The HITRESULT enumeration values are used in IViewObjectEx::QueryHitPoint and IViewObjectEx::QueryHitRect.

%HITRESULT_OUTSIDE = 0
%HITRESULT_TRANSPARENT = 1
%HITRESULT_CLOSE = 2
%HITRESULT_HIT = 3
 

OLECLOSE

The OLECLOSE enumeration constants are used in the IOleObject::Close method to determine whether the object should be saved before closing.

%OLECLOSE_SAVEIFDIRTY = 0
%OLECLOSE_NOSAVE = 1
%OLECLOSE_PROMPTSAVE = 2

OLECMDEXECOPT

The OLECMDEXECOPT enumeration specifies command execution options. One value from this enumeration is passed in the nCmdExecOpt argument of IOleCommandTarget::Exec.

%OLECMDEXECOPT_DODEFAULT = 0
%OLECMDEXECOPT_PROMPTUSER = 1
%OLECMDEXECOPT_DONTPROMPTUSER = 2
%OLECMDEXECOPT_SHOWHELP = 3

OLECMDF

The OLECMDF enumeration designates the type of support provided by an object for the command specified in an OLECMD structure.

%OLECMDF_SUPPORTED = 1
%OLECMDF_ENABLED = 2
%OLECMDF_LATCHED = 4
%OLECMDF_NINCHED = 8

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.

%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_ONTOOLBARACTIVATED = 31
%OLECMDID_FIND = 32
%OLECMDID_DELETE = 33
%OLECMDID_HTTPEQUIV = 34
%OLECMDID_HTTPEQUIV_DONE = 35
%OLECMDID_ENABLE_INTERACTION = 36
%OLECMDID_ONUNLOAD = 37
%OLECMDID_PROPERTYBAG2 = 38
%OLECMDID_PREREFRESH = 39
%OLECMDID_SHOWSCRIPTERROR = 40
%OLECMDID_SHOWMESSAGE = 41
%OLECMDID_SHOWFIND = 42
%OLECMDID_SHOWPAGESETUP = 43
%OLECMDID_SHOWPRINT = 44
%OLECMDID_CLOSE = 45
%OLECMDID_ALLOWUILESSSAVEAS = 46
%OLECMDID_DONTDOWNLOADCSS = 47
%OLECMDID_UPDATEPAGESTATUS = 48
%OLECMDID_PRINT2 = 49
%OLECMDID_PRINTPREVIEW2 = 50
%OLECMDID_SETPRINTTEMPLATE = 51
%OLECMDID_GETPRINTTEMPLATE = 52
%OLECMDID_PAGEACTIONBLOCKED = 55
%OLECMDID_PAGEACTIONUIQUERY = 56
%OLECMDID_FOCUSVIEWCONTROLS = 57
%OLECMDID_FOCUSVIEWCONTROLSQUERY = 58
%OLECMDID_SHOWPAGEACTIONMENU = 59
 

OLECMDTEXTF

The OLECMDTEXTF enumeration 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.

%OLECMDTEXTF_NONE = 0
%OLECMDTEXTF_NAME = 1
%OLECMDTEXTF_STATUS = 2

OLECONTF

The OLECONTF enumeration indicates the kind of objects to be enumerated by the returned IEnumUnknown interface. OLECONTF contains a set of bitwise constants used in the IOleContainer::EnumObjects method.

%OLECONTF_EMBEDDINGS = 1
%OLECONTF_LINKS = 2
%OLECONTF_OTHERS = 4
%OLECONTF_ONLYUSER = 8
%OLECONTF_ONLYIFRUNNING = 16

OLECREATE

Values from the OLECREATE enumeration are passed as the dwFlags parameter to the OleCreateXXX functions to indicate how the creation operation should proceed.

%OLECREATE_LEAVERUNNING = 1

OLEDCFLAGS

The OLEDCFLAGS enumeration value supplies additional information to the container about the device context that the object has requested. It is used in IOleInPlaceSiteWindowless::GetDC.

%OLEDC_NODRAW = &H1
%OLEDC_PAINTBKGND = &H2
%OLEDC_OFFSCREEN = &H4

OLEGETMONIKER

The OLEGETMONIKER enumeration constants indicate the requested behavior of the IOleObject::GetMoniker and IOleClientSite::GetMoniker methods.

%OLEGETMONIKER_ONLYIFTHERE = 1
%OLEGETMONIKER_FORCEASSIGN = 2
%OLEGETMONIKER_UNASSIGN = 3
%OLEGETMONIKER_TEMPFORUSER = 4

OLELINKBIND

The OLELINKBIND enumeration constants control binding operations to a link source. They are used in the IOleLink::BindToSource method.

%OLELINKBIND_EVENIFCLASSDIFF = 1

OLEMISC

The OLEMISC enumeration is a set of bitwise constants that can be combined to describe miscellaneous characteristics of an object or class of objects. A container can call the IOleObject::GetMiscStatus method to determine the OLEMISC bits set for an object. The values specified in an object server's CLSID\MiscStatus entry in the registration database are based on the OLEMISC enumeration. These constants are also used in the dwStatus member of the OBJECTDESCRIPTOR structure.

%OLEMISC_RECOMPOSEONRESIZE = &H1
%OLEMISC_ONLYICONIC = &H2
%OLEMISC_INSERTNOTREPLACE = &H4
%OLEMISC_STATIC = &H8
%OLEMISC_CANTLINKINSIDE = &H10
%OLEMISC_CANLINKBYOLE1 = &H20
%OLEMISC_ISLINKOBJECT = &H40
%OLEMISC_INSIDEOUT = &H80
%OLEMISC_ACTIVATEWHENVISIBLE = &H100
%OLEMISC_RENDERINGISDEVICEINDEPENDENT = &H200
%OLEMISC_INVISIBLEATRUNTIME = &H400
%OLEMISC_ALWAYSRUN = &H800
%OLEMISC_ACTSLIKEBUTTON = &H1000
%OLEMISC_ACTSLIKELABEL = &H2000
%OLEMISC_NOUIACTIVATE = &H4000
%OLEMISC_ALIGNABLE = &H8000
%OLEMISC_SIMPLEFRAME = &H10000
%OLEMISC_SETCLIENTSITEFIRST = &H20000
%OLEMISC_IMEMODE = &H40000
%OLEMISC_IGNOREACTIVATEWHENVISIBLE = &H80000
%OLEMISC_WANTSTOMENUMERGE = &H100000
%OLEMISC_SUPPORTSMULTILEVELUNDO = &H200000

OLERENDER

The OLERENDER enumeration constants are used in the various object creation functions to indicate the type of caching requested for the newly created object.

%OLERENDER_NONE = 0
%OLERENDER_DRAW = 1
%OLERENDER_FORMAT = 2
%OLERENDER_ASIS = 3

OLEUIPASTEFLAG

This enumeration is used to indicate the user options that are available to the user when pasting this format, and within which group or list of choices (Paste, Paste Link, etc.) this entry is to be available. OLEUIPASTEFLAG is used by the OLEUIPASTEENTRY structure.

%OLEUIPASTE_ENABLEICON = 2048
%OLEUIPASTE_PASTEONLY = 0
%OLEUIPASTE_PASTE = 512
%OLEUIPASTE_LINKANYTYPE = 1024
%OLEUIPASTE_LINKTYPE1 = 1
%OLEUIPASTE_LINKTYPE2 = 2
%OLEUIPASTE_LINKTYPE3 = 4
%OLEUIPASTE_LINKTYPE4 = 8
%OLEUIPASTE_LINKTYPE5 = 16
%OLEUIPASTE_LINKTYPE6 = 32
%OLEUIPASTE_LINKTYPE7 = 64
%OLEUIPASTE_LINKTYPE8 = 128

OLEUPDATE

The OLEUPDATE enumeration constants are used to indicate whether the linked object updates the cached data for the linked object automatically or only when the container calls either the IOleObject::Update or IOleLink::Update methods. The constants are used in the IOleLink interface.

%OLEUPDATE_ALWAYS = 1
%OLEUPDATE_ONCALL = 3

OLEVERBATTRIB

The OLEVERBATTRIB enumeration constants are used in the OLEVERB structure to describe the attributes of a specified verb for an object. Values are used in the enumerator (which supports the IEnumOLEVERB interface) that is created by a call to IOleObject::EnumVerbs.

%OLEVERBATTRIB_NEVERDIRTIES = 1
%OLEVERBATTRIB_ONCONTAINERMENU = 2

OLEWHICHMK

The OLEWHICHMK enumeration constants indicate which part of an object's moniker is being set or retrieved. These constants are used in the IOleObject and IOleClientSite interfaces.

%OLEWHICHMK_CONTAINER = 1
%OLEWHICHMK_OBJREL = 2
%OLEWHICHMK_OBJFULL = 3

TYMED

The TYMED enumeration values indicate the type of storage medium being used in a data transfer. They are used in the STGMEDIUM or FORMATETC structures.

%TYMED_HGLOBAL = 1
%TYMED_FILE = 2
%TYMED_ISTREAM = 4
%TYMED_ISTORAGE = 8
%TYMED_GDI = 16
%TYMED_MFPICT = 32
%TYMED_ENHMF = 64
%TYMED_NULL = 0

UASFLAGS

The UASFLAGS enumeration value supplies information about the parent undo unit. It is used in IOleParentUndoUnit::GetParentState.

%UAS_NORMAL = 0
%UAS_BLOCKED = &H1
%UAS_NOPARENTENABLE = &H2
%UAS_MASK = &H3

USERCLASSTYPE

The USERCLASSTYPE enumeration constants indicate the different variants of the display name associated with a class of objects. They are used in the IOleObject::GetUserType method and the OleRegGetUserType function.

%USERCLASSTYPE_FULL = 1
%USERCLASSTYPE_SHORT = 2
%USERCLASSTYPE_APPNAME = 3

VIEWSTATUS

The VIEWSTATUS enumeration is used in IViewObjectEx::GetViewStatus to specify the opacity of the object and the drawing aspects supported by the object.

%VIEWSTATUS_OPAQUE = 1
%VIEWSTATUS_SOLIDBKGND = 2
%VIEWSTATUS_DVASPECTOPAQUE = 4
%VIEWSTATUS_DVASPECTTRANSPARENT = 8