com.esri.arcgis.framework
Interface IComPropertyPage2

All Superinterfaces:

Serializable

All Known Implementing Classes:

AddAGSConnectionPage, AddAGSDiscoveryConnectionPage, AddAGSDiscoveryUserConnectionPage, AddAGSFolderPage, AddAGSServerPage, AGSDiscoveryAdvancedCacheSettingsPage, AGSDiscoveryArcGISOnlinePage, AGSDiscoveryCachingGeneralPage, AGSDiscoveryCapabilityDetailsPage, AGSDiscoveryCapabilityGeneralPage, AGSDiscoveryGeneralPage, AGSDiscoveryGeocodeParametersPage, AGSDiscoveryGeoDataParametersPage, AGSDiscoveryGlobeCachingPage, AGSDiscoveryGlobeParametersPage, AGSDiscoveryImageCachingGeneralPage, AGSDiscoveryImageCatalogEditingPage, AGSDiscoveryImageCatalogPage, AGSDiscoveryImageMensurationPage, AGSDiscoveryImageParametersPage, AGSDiscoveryImageServerRFxPage, AGSDiscoveryImageTilingSchemePage, AGSDiscoveryItemDescriptionPage, AGSDiscoveryMapParametersPage, AGSDiscoveryPoolingPage, AGSDiscoveryProcessPage, AGSDiscoverySearchParametersPage, AGSGeneralPage, AGSGeocodeParameterPage, AGSGeoDataServerParameterPage, AGSGeometryParameterPage, AGSGeoprocessingParameterPage, AGSImageParameterPage, AGSMapParameterPage, AGSNewCachingPage, AGSParameterPagesContainer, AGSSearchServerParameterPage, AGSServerClustersPage, AGSServerConfigStorePage, AGSServerDataStoresPage, AGSServerDirsPage, AGSServerHostsPage, AGSServerLogSettingsPage, AGSServerStatisticsPage, AGSServerTypesPage, AGSSOEPage, AnglePropertyPage, AnnoDisplayPropertyPage, AnnoLabelClassesPropertyPage, AnnoLEPropsConflictPropertyPage, AnnoLEPropsExpressionPropertyPage, AnnoLEPropsPlacementPropertyPage, AnnoPlacementPropertyPluginPage, AnnoSymbologyPropertyPage, AnnotationClassesFLPropertyPage, AnnotationClassesPropertyPage, AnnotationClassPropertyPage, AnnotationSublayerInfoPropertyPage, AreaGraphicPropertyPage, BarChartPropertyPage, BiUniqueValuePropertyPage, CadastralFabricLayerHistoryPropPage, CadUniqueValuePropertyPage, CalibratedBorderPropertyPage, CFAssociationsPage, CFEditEnvironmentPage, 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, DomainResolutionTolerancePage, DomainsPropertyPage, FeatDSNamePage, FeatDSSpaRefPage, FeatureAdjustmentAssociationPage, FeatureClassRepresentationsPage, FeatureExtentPage, FeatureLayerDisplayPropertyPage, FeatureLayerHTMLPropertyPage, FeatureLayerSelectionPropertyPage, FeatureLayerSourcePropertyPage, FeatureServerObjectPropPage, 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, GxMapSOPage, GxMSDFilePropPage, GxNASOEPage, GxObjectVisibilityPage, GxPackagePropPage, GxShapefileIndexPage, GxWCSSOEPage, GxWFSSOEPage, GxWMSSOEPage, GxWPSSOEPage, HorizontalBarLegendItemPropertyPage, HorizontalLegendItemPropertyPage, HsvPropertyPage, IComPropertyPage2Proxy, IMSLayersPropertyPage, IMSMapLayerSourcePropertyPage, IMSPropsPropertyPage, IndexGridPropertyPage, IndexTabPropertyPage, InfoItemsPage, InfoTableGeneralPage, InteriorLabelsPropertyPage, JoinRelatePage, LabelDefinitionPropertyPage, LabelStylePropertyPage, LabelWeightsPropertyPage, LayerDefinitionQueryPropertyPage, LayerDrawingPropertyPage, LayerFieldsPropertyPage, LayerLabelsPropertyPage, LayoutViewPropertyPage, LegendElementItemsPropertyPage, LegendElementPropertyPage, LegendLayoutPropertyPage, LegendPatchPropertyPage, LengthGraphicPropertyPage, LineElementPropertyPage, LocalCachePage, LookupSymbolPropertyPage, MapCachePropertyPage, MapDocumentPropPage, MapFrameLocatorPropertyPage, MapFramePropertyPage, MapGraphicsLayerPropertyPage, MapGridAxesPropertyPage, MapGridIntervalsPropertyPage, MapGridLabelsPropertyPage, MapGridLinesPropertyPage, MapGridOverlayPropertyPage, MapGridsPropertyPage, MapGridSystemPropertyPage, MapIlluminationPropertyPage, MapInsetPropertyPage, MaplexAnnoLEPropsAdvancedPropertyPage, MaplexAnnoLEPropsConflictPropertyPage, MaplexAnnoLEPropsDensityPropertyPage, MaplexAnnoLEPropsPlacementPropertyPage, MaplexAnnoLEPropsStackingPropertyPage, MaplexAnnoLEPropsStrategyPropertyPage, MaplexAnnoPlacementPropertyPluginPage, MaplexExpressionPropertyPage, MaplexLabelStylePropertyPage, MaplexOverposterOptionsPropertyPage, MapProjectionPropPage, MapPropertyPage, MapScalePropertyPage, MapServerLayerAdvancedPropertyPage, MapServerLayerCachePropertyPage, MapServerLayerSourcePropertyPage, MapServerObjectPropPage, MapServerSublayersPropertyPage, MarkerElementPropertyPage, MarkerLocationPropertyPage, MgrsGridPropertyPage, MixedFontLabelPropertyPage, MultiDotDensityPropertyPage, NestedLegendItemPropertyPage, NetCDFFeaturePropertyPage, NetCDFRasterPropertyPage, NetCDFTablePropertyPage, NetworkDirectionsGeneralPage, NetworkDirectionsLandmarksPage, NetworkDirectionsRoadDetailPage, NetworkDirectionsShieldsPage, NorthArrowElementPropertyPage, NumericPropertyPage, OverposterGeneralPropertyPage, OverviewPropertyPage, PageIndexExtentPropPage, PageIndexGeneralPropPage, PercentagePropertyPage, PictureElementPropertyPage, PieChartPropertyPage, Pre70CoveragePropertyPage, PrincipalDigitsPropertyPage, ProjectedCoordSysPropPage, ProportionalSymbolPropertyPage, ProxyServerPage, PublishAntiAliasingPage, PublishDestinationPage, PublishOptionsPage, QueryLayerSourcePropertyPage, QueryPropertyPage, RasterCoordSysPage, RatePropertyPage, RelationshipRulesPage, RepresentationClassPropertyPage, RepresentationRulesPropertyPage, ResolutionPage, RgbPropertyPage, ScaleBarFormatPropertyPage, ScaleBarLabelsAndMarksPropertyPage, ScaleBarScalePropertyPage, ScaleFormatPropertyPage, ScaleTextElementPropertyPage, ScaleTextPropertyPage, ScientificPropertyPage, SDSServerDataSourcesPage, SearchServerObjectPropPage, SingleSymbolPropertyPage, SizeAndPositionPropertyPage, StackedChartPropertyPage, SubtypesPropertyPage, SymbolBackgroundPropertyPage, SymbolBorderPropertyPage, SymbolShadowPropertyPage, TableDefCoordPage, TableDefDomainPage, TableDefEditorTrackingPage, TableDefFieldsPage, TableDefNamePage, TableDefRelationshipsPage, TableDefTolerancePage, TableDefVerticalPage, TableDefViewDescPage, TableDefWeightsPage, TableIndexPage, TextElementPropertyPage, TimeDataPropertyPage, TimeTablePropertyPage, TOCGeneralPropertyPage, TOCPatchesPropertyPage, UniqueValuePropertyPage, VersioningGeneralPropertyPage, VerticalCoordSysPropPage, VerticalLegendItemPropertyPage, WMSLayerAdvancedPropertyPage, WMSLayerSourcePropertyPage, WMSLayerStylePropertyPage, WMSSublayersPropertyPage, WorkspaceEditorTrackingPropertyPage, XYCoordSysPage, ZCoordSysPage

public interface IComPropertyPage2
extends Serializable

Provides access to members that control a COM property page.

Product Availability

Available with ArcGIS Desktop.

Method Summary

int	activate() Occurs on page creation.
boolean	applies(ISet objects) Indicates if the page applies to the specified objects.
void	apply() Applies any changes to the object(s).
void	cancel() Cancels the changes to the object(s).
void	deactivate() Destroys the page.
int	getHeight() The height of the page in pixels.
int	getHelpContextID(int controlID) The help context ID for the specified control on the page.
String	getHelpFile() The help file name for the page.
int	getPriority() The page priority.
String	getTitle() The title of the property page.
int	getWidth() The width of the page in pixels.
void	hide() Hides the page.
boolean	IComPropertyPage2_isPageDirty() Indicates if the page made any changes to the object(s).
boolean	queryCancel() Returns VARIANT_FALSE to prevent the cancel operation or VARIANT_TRUE to allow it.
void	setObjects(ISet objects) Supplies the page with the object(s) to be edited.
void	setPageSiteByRef(IComPropertyPageSite rhs1) The sheet that contains the page.
void	setPriority(int priority) The page priority.
void	setTitle(String title) The title of the property page.
void	show() Shows the page.

Method Detail

setTitle

void setTitle(String title)
              throws IOException,
                     AutomationException

The title of the property page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

String getTitle()
                throws IOException,
                       AutomationException

The title of the property page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPriority

void setPriority(int priority)
                 throws IOException,
                        AutomationException

The page priority. The higher the priority, the sooner the page appears in the containing property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

priority - The priority (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

int getPriority()
                throws IOException,
                       AutomationException

The page priority. The higher the priority, the sooner the page appears in the containing property sheet.

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.

getWidth

int getWidth()
             throws IOException,
                    AutomationException

The width of the page in pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

int getHeight()
              throws IOException,
                     AutomationException

The height of the page in pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageSiteByRef

void setPageSiteByRef(IComPropertyPageSite rhs1)
                      throws IOException,
                             AutomationException

The sheet that contains the page.

Product Availability

Available with ArcGIS Desktop.

Parameters:

rhs1 - A reference to a com.esri.arcgis.framework.IComPropertyPageSite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IComPropertyPage2_isPageDirty

boolean IComPropertyPage2_isPageDirty()
                                      throws IOException,
                                             AutomationException

Indicates if the page made any changes to the object(s).

Product Availability

Available with ArcGIS Desktop.

Returns:

The isDirty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

String getHelpFile()
                   throws IOException,
                          AutomationException

The help file name for the page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

int getHelpContextID(int controlID)
                     throws IOException,
                            AutomationException

The help context ID for the specified control on the page.

Product Availability

Available with ArcGIS Desktop.

Parameters:

controlID - The controlID (in)

Returns:

The helpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

int activate()
             throws IOException,
                    AutomationException

Occurs on page creation. Return the hWnd of the page here.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

void deactivate()
                throws IOException,
                       AutomationException

Destroys the page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

boolean applies(ISet objects)
                throws IOException,
                       AutomationException

Indicates if the page applies to the specified objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

objects - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

The pApplies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjects

void setObjects(ISet objects)
                throws IOException,
                       AutomationException

Supplies the page with the object(s) to be edited.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

objects - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

void show()
          throws IOException,
                 AutomationException

Shows the page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

void hide()
          throws IOException,
                 AutomationException

Hides the page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

void apply()
           throws IOException,
                  AutomationException

Applies any changes to the object(s).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws IOException,
                   AutomationException

Cancels the changes to the object(s).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCancel

boolean queryCancel()
                    throws IOException,
                           AutomationException

Returns VARIANT_FALSE to prevent the cancel operation or VARIANT_TRUE to allow it.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The queryCancel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.