ArcObjects Library Reference (Carto)  

IMapServer4.ExportScaleBar Method

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

[Visual Basic .NET]
Public Function ExportScaleBar ( _
    ByVal Scalebar As IScaleBar, _
    ByVal mapDesc As IMapDescription, _
    ByVal pMapDisplay As IImageDisplay, _
    ByVal BackgroundColor As IColor, _
    ByVal imageDesc As IImageDescription _
) As IImageResult
[C#]
public IImageResult ExportScaleBar (
    IScaleBar Scalebar,
    IMapDescription mapDesc,
    IImageDisplay pMapDisplay,
    IColor BackgroundColor,
    IImageDescription imageDesc
);
[C++]
HRESULT ExportScaleBar(
  IScaleBar* Scalebar,
  IMapDescription* mapDesc,
  IImageDisplay* pMapDisplay,
  IColor* BackgroundColor,
  IImageDescription* imageDesc,
  IImageResult** ImageResult
);
[C++]

Parameters

Scalebar [in]

  Scalebar is a parameter of type IScaleBar

mapDesc [in]

  mapDesc is a parameter of type IMapDescription

pMapDisplay [in]

  pMapDisplay is a parameter of type IImageDisplay

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

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also

IMapServer4 Interface