ArcObjects Library Reference (Carto)  

IMxdServer.ExportScaleBar Method

Exports a scale bar to an image file. The client can create the pScaleBar object and set its desired properties appropriately. If pScaleBar is null, a default scale bar will be generated for the default map.

[Visual Basic .NET]
Public Sub ExportScaleBar ( _
    ByVal Scalebar As IScaleBar, _
    ByVal mapImageWidthPixels As Integer, _
    ByVal Dpi As Integer, _
    ByVal imageWidth As Integer, _
    ByVal imageHeight As Integer, _
    ByVal BackgroundColor As IColor, _
    ByVal fileType As String, _
    ByVal outputFileName As String _
)
[C#]
public void ExportScaleBar (
    IScaleBar Scalebar,
    int mapImageWidthPixels,
    int Dpi,
    int imageWidth,
    int imageHeight,
    IColor BackgroundColor,
    string fileType,
    string outputFileName
);
[C++]
HRESULT ExportScaleBar(
  IScaleBar* Scalebar,
  Long mapImageWidthPixels,
  Long Dpi,
  Long imageWidth,
  Long imageHeight,
  IColor* BackgroundColor,
  BSTR fileType,
  BSTR outputFileName
);
[C++]

Parameters

Scalebar [in]

  Scalebar is a parameter of type IScaleBar

mapImageWidthPixels [in]   mapImageWidthPixels is a parameter of type Long Dpi [in]   Dpi is a parameter of type Long imageWidth [in]   imageWidth is a parameter of type Long imageHeight [in]   imageHeight is a parameter of type Long BackgroundColor [in]

  BackgroundColor is a parameter of type IColor

fileType [in]   fileType is a parameter of type BSTR outputFileName [in]   outputFileName is a parameter of type BSTR

Product Availability

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

See Also

IMxdServer Interface