IMcBasicFeaturesBasicFeatureStatusFlags Property
|
|
Basic per-feature status flags
Namespace:
MediaCy.IQL.Features
Assembly:
MediaCy.IQL.Features (in MediaCy.IQL.Features.dll) Version: 10.0.6912.0
SyntaxProperty BasicFeatureStatusFlags (
<OptionalAttribute> Selector As Object,
Optional Mask As mcBasicFeatureStatusFlags = mcBasicFeatureStatusFlags.mcbfsfAllFlags
) As Object
Get
Set
Parameters
- Selector (Optional)
- Type: SystemObject
An empty variant, a single negative value,
a single index value, or an array of zero or more index values
(negative index values are legal but will be ignored).
If the Selector argument is a non-negative scalar value, then
BasicFeatureStatusFlags of the indicated feature from the collection is
exposed or set as a scalar long value.
If the Selector argument is a value of negative one (-1), then
BasicFeatureStatusFlags of all features from the collection are exposed
or set as a scalar Long value. The property will be the OR'ed
mcBasicFeatureStatusFlags flags of all features in the collection.
If the Selector argument is missing or any negative value
other than minus 1, then the Selected property is exposed or set as an array
of 'long' mcBasicFeatureStatusFlags feature flags values, one for each
feature. The number of elements in the array will be equal to the Count
property.
If Selector is an array, then zero or positive values are treated as
indices into the features collection, negative values are legal but
ignored. In this case, the BasicFeatureStatusFlags will be exposed or set as
an array of Long values equal to the length of the number of
non-negative elements in the Selector array. Index values greater or
equal to the Count property are illegal.
Some Owners may provide more selection options. For McFeatures Owners
for example, if the argument is a McFeatures (i.e., McPoints, McLines or
McRegions) or a McBitMask, then features that intersersect the selector's
bit mask are selected as if an array of index values were supplied. If
the McFeatures.OptionFlags mcofFullCoverageIntersectionTest bit is set, then the
test is more stringent and a feature must be fully covered by the
selector's bit mask in order to be included in the selection. - Mask (Optional)
- Type: MediaCy.IQL.FeaturesmcBasicFeatureStatusFlags
A mask for the flags being set or accessed. Default value
is mcbfsfAllFlags.
Property Value
Type:
Object
RemarksThe selected status is used to determine whether a feature is
selected or not. Three of the status flags indicate why the feature is
disabled. By default, these bits of the status flags are equal to 0, which
means that the feature is selected. Possible disabling flags are
mcbfsfOutOfRange, mcbfsfDeselected and mcbfsfCancelled. Other flags can
indicate other aspects of individual feature state.
The McMeasures.Filter and McMeasure.Filter methods set the mcbfsfOutOfRange
BasicFeatureStatusFlags bit.
The property is exposed as a Variant holding Long values; each value is made up
of zero or more mcBasicFeatureStatusFlags values or'ed together. Depending on the
Selector argument, the returned Variant may be a scalar Long value of these
flags, or it may be an array of such flag values. The property is exposed as an
array if the Selector argument is an array or if it is a negative scalar value
other than -1 (when the Selector argument is -1, then the property is a scalar
Long value holding the OR'ed flags from all features).
On assignment, you may assign either a scalar Long mcBasicFeatureStatusFlags value or
an array of such Long values. The Selector argument determines which features
are set with the assigned mcBasicFeatureStatusFlags value(s). Each element in the
assigning array is used and then reused as necessary to set all of the selected
features; thus, when the assigning value is a scalar, all selected features are
assigned the same mcBasicFeatureStatusFlags value.
A new Features collection is all selected by default.
See Also