com.esri.arcgis.framework
Interface IPropertyPageContext

All Superinterfaces:

Serializable

All Known Implementing Classes:

AddAGSConnectionPage, AddAGSFolderPage, AddAGSServerPage, AGSCachingPage, AGSCapabilityPage, AGSGeneralPage, AGSGeocodeParameterPage, AGSGeoDataServerParameterPage, AGSGeometryParameterPage, AGSGeoprocessingParameterPage, AGSGlobeParameterPage, AGSImageParameterPage, AGSMapParameterPage, AGSNewCachingPage, AGSParameterPagesContainer, AGSPoolingPage, AGSProcessPage, AGSServerDirsPage, AGSServerGeneralPage, AGSServerHostsPage, AGSServerStatisticsPage, AGSServerTypesPage, AGSSOEPage, AnglePropertyPage, AnnoDisplayPropertyPage, AnnoLabelClassesPropertyPage, AnnoLEPropsConflictPropertyPage, AnnoLEPropsExpressionPropertyPage, AnnoLEPropsPlacementPropertyPage, AnnoPlacementPropertyPluginPage, AnnoSymbologyPropertyPage, AnnotationClassesFLPropertyPage, AnnotationClassesPropertyPage, AnnotationClassPropertyPage, AnnotationSublayerInfoPropertyPage, AreaGraphicPropertyPage, BarChartPropertyPage, BiUniqueValuePropertyPage, CadastralFabricLayerHistoryPropPage, CadUniqueValuePropertyPage, CalibratedBorderPropertyPage, CFAssociationsPage, CFGeneralPage, CFSourcePage, CFSubClassesPage, CmykPropertyPage, ColorNamePropertyPage, ColumnAndMarginPropertyPage, CombiUniqueValuePropertyPage, CoordSysDetailsPage, CornerLabelPropertyPage, CovAnnoFontPropertyPage, CovAnnoLevelPropertyPage, CovFCGeneralPage, CovGeneralPage, CovProjectPage, CurrencyPropertyPage, CustomPropertyPage, DataConnectionPropertyPage, DataExclusionPropertyPage, DataExclusionQueryPropertyPage, DataSamplingPropertyPage, DataViewPropertyPage, DimensionPropertyPage, DirectionPropertyPage, DisplayStringPropPage, DmsLabelPropertyPage, DocumentPropertyPage, DomainsPropertyPage, FeatDSNamePage, FeatDSSpaRefPage, FeatureAdjustmentAssociationPage, FeatureClassRepresentationsPage, FeatureLayerDisplayPropertyPage, FeatureLayerHTMLPropertyPage, FeatureLayerSelectionPropertyPage, FeatureLayerSourcePropertyPage, FillShapeElementPropertyPage, FractionPropertyPage, FramePropertyPage, GeneralDatabaseServerPropertyPage, GeneralLayerPropPage, GeneralLegendItemPropertyPage, GeneralRelationshipClassPropertyPage, GeoDataServerObjectPropPage, GeoDBAdminPropertyPage, GeographicCoordSysPropPage, GeometryServerObjectPropPage, GeoprocessingServerObjectPropPage, GlobeServerObjectPropPage, GNConnectivityRulesPropPage, GNNamePropPage, GNWeightsPropPage, GraduatedColorPropertyPage, GraduatedSymbolPropertyPage, GraphicsLayerAnnoPropertyPage, GraticuleIntervalsPropertyPage, GrayPropertyPage, GridHatchPropertyPage, GroupLayerDisplayPropertyPage, GroupLayerPropertyPage, GxAGSFolderPropertyPage, GxContentsViewPage, GxFeatureAccessSOEPage, GxFileFilterDefinitionPage, GxKMLSOEPage, GxMSDFilePropPage, GxNASOEPage, GxObjectVisibilityPage, GxPackagePropPage, GxShapefileIndexPage, GxWCSSOEPage, GxWFSSOEPage, GxWMSSOEPage, HorizontalBarLegendItemPropertyPage, HorizontalLegendItemPropertyPage, HsvPropertyPage, IMSLayersPropertyPage, IMSMapLayerSourcePropertyPage, IMSPropsPropertyPage, IndexGridPropertyPage, IndexTabPropertyPage, InfoItemsPage, InfoTableGeneralPage, InteriorLabelsPropertyPage, IPropertyPageContextProxy, JoinRelatePage, LabelDefinitionPropertyPage, LabelStylePropertyPage, LabelWeightsPropertyPage, LayerDefinitionQueryPropertyPage, LayerDrawingPropertyPage, LayerFieldsPropertyPage, LayerLabelsPropertyPage, LayoutViewPropertyPage, LegendElementItemsPropertyPage, LegendElementPropertyPage, LegendPatchPropertyPage, LengthGraphicPropertyPage, LineElementPropertyPage, LocalCachePage, LookupSymbolPropertyPage, MapCachePropertyPage, MapDocumentPropPage, MapFrameLocatorPropertyPage, MapFramePropertyPage, MapGraphicsLayerPropertyPage, MapGridAxesPropertyPage, MapGridIntervalsPropertyPage, MapGridLabelsPropertyPage, MapGridLinesPropertyPage, MapGridOverlayPropertyPage, MapGridsPropertyPage, MapGridSystemPropertyPage, MapIlluminationPropertyPage, MapInsetPropertyPage, MaplexAnnoLEPropsAdvancedPropertyPage, MaplexAnnoLEPropsConflictPropertyPage, MaplexAnnoLEPropsPlacementPropertyPage, MaplexAnnoLEPropsStackingPropertyPage, MaplexAnnoLEPropsStrategyPropertyPage, MaplexAnnoPlacementPropertyPluginPage, MaplexLabelStylePropertyPage, MaplexOverposterOptionsPropertyPage, MapProjectionPropPage, MapPropertyPage, MapScalePropertyPage, MapServerLayerAdvancedPropertyPage, MapServerLayerCachePropertyPage, MapServerLayerSourcePropertyPage, MapServerObjectPropPage, MapServerSublayersPropertyPage, MarkerElementPropertyPage, MarkerLocationPropertyPage, MgrsGridPropertyPage, MixedFontLabelPropertyPage, MultiDotDensityPropertyPage, NestedLegendItemPropertyPage, NetCDFFeaturePropertyPage, NetCDFRasterPropertyPage, NetCDFTablePropertyPage, NetworkDirectionsGeneralPage, NetworkDirectionsRoadDetailPage, NetworkDirectionsShieldsPage, NetworkDirtyAreaRendererPropertyPage, NetworkTrafficRendererPropertyPage, NorthArrowElementPropertyPage, NumericPropertyPage, OverposterGeneralPropertyPage, OverviewPropertyPage, PageIndexExtentPropPage, PageIndexGeneralPropPage, PercentagePropertyPage, PictureElementPropertyPage, PieChartPropertyPage, Pre70CoveragePropertyPage, PrincipalDigitsPropertyPage, ProjectedCoordSysPropPage, ProportionalSymbolPropertyPage, ProxyServerPage, QueryLayerSourcePropertyPage, QueryPropertyPage, RasterCoordSysPage, RatePropertyPage, RelationshipRulesPage, RepresentationClassPropertyPage, RepresentationRulesPropertyPage, ResolutionPage, RgbPropertyPage, ScaleBarFormatPropertyPage, ScaleBarLabelsAndMarksPropertyPage, ScaleBarScalePropertyPage, ScaleFormatPropertyPage, ScaleTextElementPropertyPage, ScaleTextPropertyPage, ScientificPropertyPage, SearchServerObjectPropPage, SimpleNetworkRendererPropertyPage, SingleSymbolPropertyPage, SizeAndPositionPropertyPage, StackedChartPropertyPage, SubtypesPropertyPage, SymbolBackgroundPropertyPage, SymbolBorderPropertyPage, SymbolShadowPropertyPage, TableDefCoordPage, TableDefDomainPage, TableDefFieldsPage, TableDefNamePage, TableDefRelationshipsPage, TableDefTolerancePage, TableDefVerticalPage, TableDefWeightsPage, TableIndexPage, TextElementPropertyPage, TimeDataPropertyPage, TimeTablePropertyPage, TOCGeneralPropertyPage, TOCPatchesPropertyPage, UniqueValuePropertyPage, VersioningGeneralPropertyPage, VerticalCoordSysPropPage, VerticalLegendItemPropertyPage, WMSLayerAdvancedPropertyPage, WMSLayerSourcePropertyPage, WMSLayerStylePropertyPage, WMSSublayersPropertyPage, XYCoordSysPage, ZCoordSysPage

public interface IPropertyPageContext
extends Serializable

Provides access to members that helps you find out if property page applies to a set of objects.

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	applies(Object unkArray) Check if property page applies to the specified set of objects.
void	cancel() Property sheet calls this when cancel button is pressed.
Object	createCompatibleObject(Object kind) Create a new object using the specified object as a template.
String	getHelpFile(int controlID) Returns the help file name for the specified control.
int	getHelpId(int controlID) Returns the help ID for the specified control.
int	getPriority() The page's priority relative to other pages that interact with the same object.
void	queryObject(Object theObject) Apply the property page settings to the specified object.

Method Detail

getPriority

int getPriority()
                throws IOException,
                       AutomationException

The page's priority relative to other pages that interact with the same object. The higher the value, the higher the priority.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The priority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

boolean applies(Object unkArray)
                throws IOException,
                       AutomationException

Check if property page applies to the specified set of objects. Signature corresponds to IPropertyPage::SetObjects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

unkArray - A Variant (in)

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createCompatibleObject

Object createCompatibleObject(Object kind)
                              throws IOException,
                                     AutomationException

Create a new object using the specified object as a template. The kind argument may be NULL if the page interacts with only a single object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

kind - A Variant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryObject

void queryObject(Object theObject)
                 throws IOException,
                        AutomationException

Apply the property page settings to the specified object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theObject - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

String getHelpFile(int controlID)
                   throws IOException,
                          AutomationException

Returns the help file name for the specified control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

controlID - The controlID (in)

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpId

int getHelpId(int controlID)
              throws IOException,
                     AutomationException

Returns the help ID for the specified control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

controlID - The controlID (in)

Returns:

The helpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws IOException,
                   AutomationException

Property sheet calls this when cancel button is pressed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.