SetLabelText Method

Description

The Label for each of the McGraphObj instances is displayed or cleared.

Return Type

None

Syntax

object.SetLabelText bstrLabelTextOrKeyword, [mcsltFlags], [lTextColor], [varIFontDisp]

The SetLabelText Method syntax has these parts:

Part	Description
object	An expression evaluating to an object of type McDisplayedObjects.
bstrLabelTextOrKeyword	Required. A String value.
mcsltFlags	Optional. A mcSetLabelTextFlags enumeration, as described in settings. setting the TextColor. If -1 and neither the mcsltCopyBorderColor nor mcsltCopyFillColor mcsltFlags are given, then the label color is left alone.
lTextColor	Optional. A Long value. If not -1 (the default), then this is the TextColor property to set for the labels. Any value other than -1 will override any
varIFontDisp	Optional. A Variant value. If given, a standard IFontDisp interface instance that describes the font to use for the text display. If not given, the default font for the label text is used.

Settings

The settings for mcsltFlags are:

Constant		Value	Description
	mcsltNoFlags	0	No flags
	mcsltDisplayFeatureIndex	1	If set, include the index with %d
	mcsltDisplayFeatureID	2	If set, include the McFeature.Identifier with d or x
	mcsltDisplaySourceData	3	If set, include the McFeature.SourceData with s if it is a string or with f or g if it is a floating point type or with d or %x otherwise. Since you can assign a separate value to each feature's SourceData property, this choice allows you to assign an arbitrarily different label to each feature.
	mcsltDisplayGraphID	4	If set, include the McGraphObj ID with d or x
	mcsltDisplaySourceFlags	5	If set, include the McFeature.SourceFlags with %d. Since you can assign a separate value to each feature's SourceFlags property, this choice allows you to assign an different integer label to each feature. The SourceFlags property can be assigned from an array, making it convenient to set values for all features in one assignment.
	mcsltDisplayNumberMask	15	Mask for the display number flags
	mcsltCopyBorderColor	16	if set, set TextColor to Feature BorderColor
	mcsltCopyFillColor	32	if set, set TextColor to Feature FillColor
	mcsltTextColorMask	48	Mask for the TextColor control bits
	mcsltLabelTopleft	1048576	Object has a top left label attached.
	mcsltLabelTopright	2097152	Object has a top right label attached.
	mcsltLabelBtmleft	4194304	Object has a bottom left label attached.
	mcsltLabelBtmright	8388608	Object has a bottom right label attached.
	mcsltLabelCenter	16777216	Object has a bottom center label attached.
	mcsltLabelLinebgn	33554432	Display the label underneath the object.
	mcsltLabelLineend	67108864	Display the label near the last point of the object.
	mcsltLabelInside	134217728	The label is shown inside rather than outside the specified position. For mcsltLabelCenter, mcsltLabelLinebgn and mcsltLabelLineend, the position is moved to the other side of the specified position.
	mcsltLabelHidden	268435456	The label is hidden, but not destroyed.
	mcsltLabelPositionMask	267386880	Mask for the label position flags, one must be set to display a label
	mcsltLabelStyleMask	535822336	Mask for the label position and hidden flags
	mcsltDefault	16777233	include the Feature Indexwith %d, set TextColor to Feature BorderColor and Object has a bottom center label attached

Remarks

With a single call to this method, the label text can be set as well as the label position and the label text color.