com.esri.arcgis.arcmapui
Interface IDocumentDefaultSymbols

All Superinterfaces:

Serializable

All Known Implementing Classes:

GMxDocument, IDocumentDefaultSymbolsProxy, MxDocument

public interface IDocumentDefaultSymbols
extends Serializable

Provides access to members that control Default Symbols for the document.

Product Availability

Available with ArcGIS Desktop.

Method Summary

IAreaPatch	getAreaPatch() Default Area Patch.
IFormattedTextSymbol	getCallout() Default Callout.
Font	getCustomTOCFont() Custom TOC Font.
double	getCustomTOCFontSize() Custom TOC Font Size in Points.
IFillSymbol	getFillSymbol() Default Fill Symbol.
ILinePatch	getLinePatch() Default Line Patch.
ILineSymbol	getLineSymbol() Default Line Symbol.
IMarkerSymbol	getMarkerSymbol() Default Marker Symbol.
double	getPatchHeight() Default Patch Height in Points.
double	getPatchWidth() Default Patch Width in Points.
ITextSymbol	getTextSymbol() Default Text Symbol.
void	setAreaPatch(IAreaPatch patch) Default Area Patch.
void	setCallout(IFormattedTextSymbol callout) Default Callout.
void	setCustomTOCFont(Font font) Custom TOC Font.
void	setCustomTOCFontSize(double fontSizePts) Custom TOC Font Size in Points.
void	setFillSymbol(IFillSymbol lSymbol) Default Fill Symbol.
void	setLinePatch(ILinePatch patch) Default Line Patch.
void	setLineSymbol(ILineSymbol lineSymbol) Default Line Symbol.
void	setMarkerSymbol(IMarkerSymbol markerSymbol) Default Marker Symbol.
void	setPatchHeight(double heightPts) Default Patch Height in Points.
void	setPatchWidth(double widthPts) Default Patch Width in Points.
void	setTextSymbol(ITextSymbol textSymbol) Default Text Symbol.

Method Detail

setFillSymbol

void setFillSymbol(IFillSymbol lSymbol)
                   throws IOException,
                          AutomationException

Default Fill Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

lSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

IFillSymbol getFillSymbol()
                          throws IOException,
                                 AutomationException

Default Fill Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineSymbol

void setLineSymbol(ILineSymbol lineSymbol)
                   throws IOException,
                          AutomationException

Default Line Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

lineSymbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineSymbol

ILineSymbol getLineSymbol()
                          throws IOException,
                                 AutomationException

Default Line Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMarkerSymbol

void setMarkerSymbol(IMarkerSymbol markerSymbol)
                     throws IOException,
                            AutomationException

Default Marker Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

markerSymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMarkerSymbol

IMarkerSymbol getMarkerSymbol()
                              throws IOException,
                                     AutomationException

Default Marker Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbol

void setTextSymbol(ITextSymbol textSymbol)
                   throws IOException,
                          AutomationException

Default Text Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

textSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

Default Text Symbol.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCallout

void setCallout(IFormattedTextSymbol callout)
                throws IOException,
                       AutomationException

Default Callout.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

callout - A reference to a com.esri.arcgis.display.IFormattedTextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCallout

IFormattedTextSymbol getCallout()
                                throws IOException,
                                       AutomationException

Default Callout.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.display.IFormattedTextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAreaPatch

void setAreaPatch(IAreaPatch patch)
                  throws IOException,
                         AutomationException

Default Area Patch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

patch - A reference to a com.esri.arcgis.carto.IAreaPatch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAreaPatch

IAreaPatch getAreaPatch()
                        throws IOException,
                               AutomationException

Default Area Patch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.carto.IAreaPatch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLinePatch

void setLinePatch(ILinePatch patch)
                  throws IOException,
                         AutomationException

Default Line Patch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

patch - A reference to a com.esri.arcgis.carto.ILinePatch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLinePatch

ILinePatch getLinePatch()
                        throws IOException,
                               AutomationException

Default Line Patch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.carto.ILinePatch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchWidth

void setPatchWidth(double widthPts)
                   throws IOException,
                          AutomationException

Default Patch Width in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

widthPts - The widthPts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPatchWidth

double getPatchWidth()
                     throws IOException,
                            AutomationException

Default Patch Width in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The widthPts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPatchHeight

void setPatchHeight(double heightPts)
                    throws IOException,
                           AutomationException

Default Patch Height in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

heightPts - The heightPts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPatchHeight

double getPatchHeight()
                      throws IOException,
                             AutomationException

Default Patch Height in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The heightPts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomTOCFont

void setCustomTOCFont(Font font)
                      throws IOException,
                             AutomationException

Custom TOC Font.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomTOCFont

Font getCustomTOCFont()
                      throws IOException,
                             AutomationException

Custom TOC Font.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomTOCFontSize

void setCustomTOCFontSize(double fontSizePts)
                          throws IOException,
                                 AutomationException

Custom TOC Font Size in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

fontSizePts - The fontSizePts (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomTOCFontSize

double getCustomTOCFontSize()
                            throws IOException,
                                   AutomationException

Custom TOC Font Size in Points.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The fontSizePts

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.