com.esri.arcgis.display
Interface IStyleGalleryClass

All Superinterfaces:
Serializable
All Known Implementing Classes:
AreaPatchStyleGalleryClass, BackgroundStyleGalleryClass, BorderStyleGalleryClass, ColorRampStyleGalleryClass, ColorStyleGalleryClass, FillSymbolStyleGalleryClass, LabelStyleGalleryClass, LegendItemStyleGalleryClass, LinePatchStyleGalleryClass, LineSymbolStyleGalleryClass, MaplexLabelStyleGalleryClass, MarkerSymbolStyleGalleryClass, NorthArrowStyleGalleryClass, RepresentationMarkerStyleGalleryClass, RepresentationRuleStyleGalleryClass, ScaleBarStyleGalleryClass, ScaleTextStyleGalleryClass, ShadowStyleGalleryClass, TextSymbolStyleGalleryClass

public interface IStyleGalleryClass
extends Serializable

Provides access to members that control the Style Gallery Class.

Description

The IStyleGalleryClass interface gives you access to the class Name, Description, and type of new objects that can be created with the class. Using this interface, you can create new style items using the EditProperties of an item, then draw a Preview of the item to a window.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void editProperties(Object[] galleryItem, IComPropertySheetEvents listener, int hWnd, boolean[] ok)
          Edits the properties of a Style Gallery Item of the supported class.
 String getDescription()
          Description for the Style Gallery Class.
 GUID getItemClass()
          Interface ID for the items in the class.
 String getName()
          Name of the Style Gallery Class(as in the stle file).
 Object getNewObject(String newType)
          Creates a new object of the specified type.
 IEnumBSTR getNewObjectTypes()
          The available types of new items in this class.
 double getPreviewRatio()
          The width ratio to 1 height.
 void preview(Object galleryItem, int hDC, tagRECT rectangle)
          Draws a preview of a Style Gallery Item of the supported class.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the Style Gallery Class(as in the stle file).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
Description for the Style Gallery Class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The description
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemClass

GUID getItemClass()
                  throws IOException,
                         AutomationException
Interface ID for the items in the class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A Structure: com.esri.arcgis.support.ms.stdole.GUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNewObjectTypes

IEnumBSTR getNewObjectTypes()
                            throws IOException,
                                   AutomationException
The available types of new items in this class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNewObject

Object getNewObject(String newType)
                    throws IOException,
                           AutomationException
Creates a new object of the specified type.

Product Availability

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

Parameters:
newType - The newType (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPreviewRatio

double getPreviewRatio()
                       throws IOException,
                              AutomationException
The width ratio to 1 height.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The ratio
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

preview

void preview(Object galleryItem,
             int hDC,
             tagRECT rectangle)
             throws IOException,
                    AutomationException
Draws a preview of a Style Gallery Item of the supported class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
galleryItem - A reference to another Object (IUnknown) (in)
hDC - The hDC (A COM typedef) (in)
rectangle - A Structure: com.esri.arcgis.display.tagRECT (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

editProperties

void editProperties(Object[] galleryItem,
                    IComPropertySheetEvents listener,
                    int hWnd,
                    boolean[] ok)
                    throws IOException,
                           AutomationException
Edits the properties of a Style Gallery Item of the supported class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
galleryItem - A reference to another Object (IUnknown) (in)
listener - A reference to a com.esri.arcgis.systemUI.IComPropertySheetEvents (in)
hWnd - The hWnd (A COM typedef) (in)
ok - The ok (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.