This document is archived and information here might be outdated. Recommended version. |
Provides access to members that control a collection of symbols and id pairs.
Name | Description | |
---|---|---|
AddSymbol | Adds a symbol to the collection. The ID will be set by the collection. | |
Count | The number of symbols in the collection. | |
GetSymbolIdentifier | Returns the symbol with the given ID. | |
Next | Returns the next symbolID-symbol pair in the collection. | |
Remove | Removes the symbolID-symbol pair in the collection. | |
RemoveAll | Removes all the symbolID-symbol pairs in the collection. | |
RenameSymbol | Renames the symbol with the given ID. | |
Replace | Replaces the symbol associated with the symbolID. | |
Reset | Prepares the collection for Next to be called. | |
Symbol | The symbol associated with the symbolID. |
CoClasses and Classes | Description |
---|---|
SymbolCollection | Collection of symbols and id pairs. |
ISymbolCollection provides access to the members of the symbol collection. This interface is most commonly used to maintain the symbol collection of an AnnotationFeatureClassExtension. Care should be taken when modifying symbols in the collection of an AnnotationFeatureClassExtension. Updating a TextSymbol property for an existing symbol in use that results in a change in the size or shape of a TextElement will result in a disconnect between the drawn symbol and the feature geometry. This can be resolved by updating the out of sync features by calling IFeature::Store, but it is generally recommended that only new symbols should be added. ISymbolCollection2 provides new methods for adding new symbols to the collection and guaranteeing unique symbol IDs. It is recommended that developers use ISymbolCollection2::AddSymbol method to add symbols to the symbol collection. A SymbolCollection must have at least one symbol and the default symbol for any Annotation Class cannot be deleted.