SetCollectedProp
Overview | Properties | Methods
Sets the properties for the collected data element.
Syntax
long = PieChartObject.SetCollectedProp([Label As String], [Color As Long = 16711680], [Texture As String])
The SetCollectedProp method syntax has the following parts:
|
Part |
Description |
|
Label |
The label which will be displayed next to the collected data element. |
|
Color |
The underlying color to be used for the collected pie slice. |
|
Texture |
The texture to be used for the collected data element. |
|
long |
Returns a long indicating the success or failure of the operation. Zero (0) is returned if successful, otherwise a non-zero value is returned. |
Returns
A long which indicates the success/failure of the operation. Zero (0) is returned if successful, otherwise a non-zero value is returned. If an error occurs you can use this return value as the argument for GetErrorText in order to retrieve a relevant text error message, or alternatively you can rem out the "On Error Resume Next" statement and observe the thrown exception for a description of the error.
Remarks
Small data elements are "collected" and then displayed together as one pie slice called the "collected" element.
SetCollectedProp sets the properties of the collected pie slice. If the template (which MUST be loaded before calling this method) defines default values for the collected data element then these default values will be used if you do not specify a collected property. For example, if you call SetCollectedProp and specify a label and underlying color to be used for the collected pie slice then the default values (if they are defined in the template) will not be used, but the default texture will be used since we did not specify a texture in the SetCollectedProp call.
See Also: SetCollectedLimit | LoadTemplate | Template Creator Overview