mcobjUserFlags Enumeration |
|
Constants for the McObject.UserFlags property. Note: must matchV:\Native\McObj\McObjDef.h !!! Note that the mcobjUserFlagNoAddRefInterface
occupies the DIRTY_FLAG and is handled specially by
CMcObject::get/put_UserFlags. Similarly the mcobjUserFlagCreatedByMainEngine
occupies the CONFIG_MEMBER_FLAG and is handled specially by
CMcObject::get_UserFlags (it is not assignable). Also note that the
mcobjUserFlagKeepByRefVariants occupies the EXTRACT_IT_FLAG.
Namespace: MediaCy.IQL.ObjectManager
Assembly: MediaCy.IQL.ObjectManager (in MediaCy.IQL.ObjectManager.dll) Version: 10.0.6912.0
SyntaxVB
Public Enumeration mcobjUserFlags
Members| Member name | Value | Description | |
|---|---|---|---|
| mcobjUserFlagsCleared | 0 | All flags cleared | |
| mcobjUserFlagsAll | -1 | All flags | |
| mcobjUserFlagNoAddRefInterface | 4 | When set, objects of typemcobjTypeXOBJECT and mcobjTypeINTERFACE do NOT AddRef/Release their interface data, but instead leave this as a reponsibility of the caller. | |
| mcobjUserFlagAlwaysVector | 32 | When set, scalar objectvalues are exposed as a safe array. This flag is set or cleared automatically when the Value property is assigned. It can subsequently be set or cleared to override the default behavior. | |
| mcobjUserFlagKeepByRefVariants | 64 | When set, objects of typemcobjTypeVARIANT will not copy the referred-to data of VT_BYREF variants. If clear (the default), then the data is copied. | |
| mcobjUserFlagPropertyOfParent | 128 | Causes anyvalue change to fire a SNC_NOTIFY_HO_PROPERTYCHANGED SpecialNotify on the object's parent. The notify data will be the object's TagNumber. | |
| mcobjUserFlagMinimizeProcessing | 256 | When set, gives a hint tonotify sinks or other processing code that the object is largely private and should be minimally processed if possible. This flag has no effect on the firing of notifies or other processing internal to the object manager, but it can be interpreted as needed by user code. * If this flag is set on the McObject backing a McImage instance, i.e., McEngine.McObject(mcimageInstance), then some clients are not sent certain events. In particular, most McImages events are not fired at all, even if the McImage is part of the McEngine.Images collection, and ImageChanged events are minimally handled. This state is designed for cases where very rapid image changes are made that need to be displayed, but not processed otherwise. If you want to do further processing on the image after turning off this flag, you should do a final assignment or call McRegionAccess.SignalImageChanged on the image. | |
| mcobjUserFlagNotifyOnGetValue | 512 | When set, anmcobjSNCode_BeforeGetValue SpecialNotify is sent to standard notify clients before the Value property is returned. This allows a notify sink to set the object's Value only when it is requested. See McObject.Value for more discussion. | |
| mcobjUserFlagDisableNotifies | 32768 | When set, standardnotifies are not sent to Notify Sinks attached to the object. You may set this flag temporarily when you will be doing a series of assignments to the Value property, and do not want to send a ValueChanged notify for each assignment. Rememeber to clear this flag before doing the last Value assignment or before doing a FireStandardNotifyToAllSinks. | |
| mcobjUserFlagReadOnly | 16384 | When set, assignment toValue is illegal | |
| mcobjUserFlagSystemObject | 1024 | When set, Name andTagNumber cannot be changed | |
| mcobjUserFlagOptionBase1 | 0 | This flag is obsolete andno longer supported. | |
| mcobjUserFlagsCustomMask | 16711680 | Bits 24 thru 17 areavailable for the caller's custom use | |
| mcobjUserFlagsSettableMask | 16762740 | Only these bits aresettable, all others are reserved. Assignments are automatically and silently masked by this value. |
See Also