IConvertLabelsToAnnotation.Initialize Method

Call this method first to initialize the converter.

[Visual Basic .NET]
Public Sub Initialize ( _
    ByVal pMap As IMap, _
    ByVal storageType As esriAnnotationStorageType, _
    ByVal whichFeatures As esriLabelWhichFeatures, _
    ByVal generateUnplacedAnnotation As Boolean, _
    ByVal pTrackCancel As ITrackCancel, _
    [ByVal pAnnotationErrorEvents As IAnnotationErrorEvents] _
)

[C#]
public void Initialize (
    IMap pMap,
    esriAnnotationStorageType storageType,
    esriLabelWhichFeatures whichFeatures,
    bool generateUnplacedAnnotation,
    ITrackCancel pTrackCancel,
    IAnnotationErrorEvents pAnnotationErrorEvents
);

[C++]
HRESULT Initialize(
  IMap* pMap,
  esriAnnotationStorageType storageType,
  esriLabelWhichFeatures whichFeatures,
  VARIANT_BOOL generateUnplacedAnnotation,
  ITrackCancel* pTrackCancel,
  IAnnotationErrorEvents* pAnnotationErrorEvents
);

[C++]

Parameters
pMap [in]

  pMap is a parameter of type IMap
storageType [in]

  storageType is a parameter of type esriAnnotationStorageType
whichFeatures [in]

  whichFeatures is a parameter of type esriLabelWhichFeatures
generateUnplacedAnnotation [in]
  generateUnplacedAnnotation is a parameter of type VARIANT_BOOL
pTrackCancel [in]

  pTrackCancel is a parameter of type ITrackCancel
pAnnotationErrorEvents [in, optional, defaultvalue(0)]

  pAnnotationErrorEvents is a parameter of type IAnnotationErrorEvents

Product Availability

Remarks

This method initializes the conversion object with the global parameters for conversion.  It is the first method that should be called when using the ConvertLabelsToAnnotation object.  The initialization has the following inputs:

• A reference to the Map you wish to convert labels from
• The storage type for the output annotation specified as an esriAnnotationStorageType value.
• Which features you would like to convert specified as an  esriLabelWhichFeatures value. 
• The option to generate unplaced annotation (True or False)
• A reference to cancel tracker
• Optionally, a reference to an error event handler.

See Also

.NET Related Topics