IMapServerLayout.ExportNorthArrow Method

Exports a north arrow to an image file. The client can create the arrow object and set its desired properties appropriately. If arrow is Nothing/Null, a default north arrow will be generated.

[Visual Basic .NET]
Public Function ExportNorthArrow ( _
    ByVal arrow As INorthArrow, _
    ByVal mapDesc As IMapDescription, _
    ByVal BackgroundColor As IColor, _
    ByVal imageDesc As IImageDescription _
) As IImageResult

[C#]
public IImageResult ExportNorthArrow (
    INorthArrow arrow,
    IMapDescription mapDesc,
    IColor BackgroundColor,
    IImageDescription imageDesc
);

[C++]
HRESULT ExportNorthArrow(
  INorthArrow* arrow,
  IMapDescription* mapDesc,
  IColor* BackgroundColor,
  IImageDescription* imageDesc,
  IImageResult** ImageResult
);

[C++]
Parameters
arrow [in]
  arrow is a parameter of type INorthArrow
mapDesc [in]
  mapDesc is a parameter of type IMapDescription
BackgroundColor [in]
  BackgroundColor is a parameter of type IColor
imageDesc [in]
  imageDesc is a parameter of type IImageDescription
ImageResult [out, retval]
  ImageResult is a parameter of type IImageResult

Product Availability

Remarks

Use ExportNorthArrow to export the map's north arrow. To customize the north arrow (e.g. size) or to change the type of north arrow marker pass in a NorthArrow object. If you pass in Nothing/Null for this input parameter, a standard north arrow is drawn. A color background can be set for the North Arrow swatch by using the backgroundColor parameter. If this is Nothing/Null a white background will be used. Use TransparentColor in IImageDisplay2 if you want the background to be transparent. Size, resolution and file format are determined by ImageDescription, which includes ImageDisplay and ImageType. ExportNorthArrow results in an ImageResult object.

The orientation of the NorthArrow is determined by the MapRotation property on IMapDescription.

ExportNorthArrow output does not require a size. A default size is calculated based on the size of the NorthArrowMarker symbol. Setting 0 for both the height and the width property of IImageDisplay for ExportNorthArrow output results in a default size that best fits the NorthArrowMarker symbol.

See Also