NewObjects

VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetwork(MSDN)WebsiteforthelatestinformationaboutprogrammingwithMicrosoftOffice2003WebComponents,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistsobjectsaddedtotheMicrosoftOffice2003WebComponentsobjectmodel.

Object DescriptionChScrollView Usethepropertiesandmethodsofthe

ChScrollViewobjectreturninformationabout,ortoscrollandzoomtheviewofachart.

ChSelectionCollection UsetheChSelectionCollectioncollectiontoworkwithallcurrentlyselectedobjectsinachart.

ListObject AListObjectobjectrepresentsanXMLlistonaworksheet.

ListObjects UsethepropertiesandmethodsoftheListObjectscollectiontoworkwithalltheXMLlistsonaworksheet.

ListRow AListRowobjectrepresentsarowinanXMLlist.

ListRows UsethetheListRowscollectiontoworkwiththealltherowsinanXMLlist.

XmlDataBinding AnXmlDataBindingobjectrepresentsanXMLdatabindingforXMLlistsandmappeddatainaSpreadsheetcomponent.

XmlDataBindings UsetheXmlDataBindingscollectiontoworkwithalltheXMLdatabindingsinaSpreadsheetcomponent.

XmlMap AnXmlMapobjectrepresentsanXMLschemamapthatmapsXMLdatatotheworksheetsinaSpreadsheetcomponent.

XmlMaps UsetheXmlMapscollectiontoworkwithallof

theXMLschemamapsinaSpreadsheetcomponent.

NewProperties(AlphabeticalList)

VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetwork(MSDN)WebsiteforthelatestinformationaboutprogrammingwithMicrosoftOffice2003WebComponents,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistspropertiesaddedtotheMicrosoftOffice2003WebComponentsobjectmodel(sortedalphabetically).

NewProperty Object(s)Active ListRowAllowUISelection ChartSpaceAsync XmlDataBindingBarWidth ChChartBindingData XmlDataBindingBindingInProgress XmlDataBinding,XmlDataBindingsCanQuery XmlDataBindingCanUpdate XmlDataBindingDataBodyRange ListObjectDefaultQueryOnLoad SpreadsheetHeaderRowRange ListObjectHorizontalExtent ChScrollViewHorizontalExtentMax ChScrollViewHorizontalPosition ChScrollViewInsertRowRange ListObjectListObject Range,WorkbookListObjects WorksheetListRows ListObjectLoadMode XmlDataBindingMapData XmlMapPropNames ListObjectScrollView ChChart

SelectionCollection ChartSpaceVerticalExtent ChScrollViewVerticalExtentMax ChScrollViewVerticalPosition ChScrollViewXmlDataBindings WorkbookXmlMap XmlDataBindingXmlMaps Workbook

NewProperties(byObject)

VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetwork(MSDN)WebsiteforthelatestinformationaboutprogrammingwithMicrosoftOffice2003WebComponents,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistspropertiesaddedtotheMicrosoftOffice2003WebComponentsobjectmodel(sortedbyobjectname).

Object NewPropertiesChartSpace AllowUISelection,SelectionCollectionChChart BarWidth,ScrollViewChScrollView HorizontalExtent,HorizontalExtentMax,

HorizontalPosition,VerticalExtent,VerticalExtentMax,VerticalPosition

ListObject DataBodyRange,HeaderRowRange,InsertRowRange,ListRows,PropNames

ListRow ActivePivotField SubtotalLabelBackColor,SubtotalLabelFont,

SubtotalLabelForeColor,SubtotalLabelHAlignment

Range ListObjectSpreadsheet DefaultQueryOnLoadWorkbook ListObject,XmlDataBindings,XmlMapsWorksheet ListObjectsXmlDataBinding Async,BindingData,BindingInProgress,

CanQuery,CanUpdate,LoadMode,XmlMapXmlDataBindings BindingInProgressXmlMap MapData

NewMethods(AlphabeticalList)

VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetwork(MSDN)WebsiteforthelatestinformationaboutprogrammingwithMicrosoftOffice2003WebComponents,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistsmethodsaddedtotheMicrosoftOffice2003WebComponentsobjectmodel(sortedalphabetically).

NewMethod ObjectAdd XmlDataBindings,XmlMapsDelete XmlDataBinding,XmlMapExportMetaData XmlMapFireParametersOut SpreadsheetGetDataPointVisible ChSeriesExportXML XmlMapImportXml XmlMapOverrideDefaultElementFormatting ChChartDrawRefresh XmlDataBindingSelect2 ChPointSetExtent ChScrollViewSetPosition ChScrollViewUpdate XmlDataBindingValidate Range

NewMethods(byObject)

VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetwork(MSDN)WebsiteforthelatestinformationaboutprogrammingwithMicrosoftOffice2003WebComponents,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistsmethodsaddedtotheMicrosoftOffice2003WebComponentsobjectmodel(sortedbyobjectname).

Object NewMethodChChartDraw OverrideDefaultElementFormattingChPoint Select2ChScrollView SetExtent,SetPositionChSeries GetDataPointVisibleRange ValidateSpreadsheet FireParametersOutXmlDataBinding Delete,Refresh,UpdateXmlDataBindings AddXmlMap Delete,ExportMetaData,ExportXML,ImportXmlXmlMaps Add

NewEvents

VisittheOfficeDeveloperCenterontheMicrosoftDeveloperNetwork(MSDN)WebsiteforthelatestinformationaboutprogrammingwithMicrosoftOffice2003WebComponents,includingproductnews,technicalarticles,downloads,andsamples.

ThefollowingtablelistseventsaddedtotheMicrosoftOffice2003WebComponentsobjectmodel.

NewEvent ObjectBindingAdded SpreadsheetBindingCompleted SpreadsheetBindingDeleted SpreadsheetBindingError SpreadsheetBindingUpdated SpreadsheetParametersOutReady SpreadsheetRowReady Spreadsheet

MakingConnectionstoExternalDataSourcesMoreSecureWhenyoudefineaconnectiontoanexternaldatasourceforanOfficeWebcomponentonaWebpage,thisinformationisstoredasanunencrypted(plaintext)connectionstringintheHTMLsource.Asaresult,auseropeningthepageinabrowsercaneasilyviewtheHTMLsourceforthepageandreadtheconnectionstring,whichmayincludeausernameandpassword,dependingonhowyoudefinedtheconnection.

Topreventunauthorizedaccessusinginformationfromtheconnectionstring,ifthedatasourcesupportsthismodeofauthentication,useWindowsAuthentication(alsoreferredtoasaTrustedConnectionandIntegratedSecurity),whichusesthecurrentuser'sMicrosoftWindowsaccounttoconnecttoanexternaldatasource.UsingWindowsAuthenticationtoconnecttoanexternaldatasourcehasthefollowingadvantages:

Theprogrammerorpagedesignerdoesn'thavetoenterausernameorpasswordtoconnecttothedatasource,sothatinformationcannotbeexposedinthepage'sHTMLsource.

Theuserofthepagedoesn'thavetoenterausernameorpasswordtoconnecttothedatasourcewhenopeningthepage,sothatinformationcannotbecompromisedwhileit'sbeingsenttotheserver.

OnlyaWindowsuseraccountthatisconfiguredinthesecuritysystemforthedatasourcewillbeallowedtoconnecttothatdatasource.

ImportantTouseWindowsAuthentication,theusersyouwanttoconnecttoanexternaldatasourcemusthaveuseraccountsonaWindowsdomain.UsersthataremembersofaWindowsWorkgroupcannotuseWindowsAuthentication.

DefiningaConnectioninanOfficeWebComponent'sUserInterfaceForexample,toconnecttoMicrosoftSQLServerusingWindowsAuthenticationfromtheuserinterfaceoftheSpreadsheetcomponent,usethefollowingprocedurewhendefiningaconnection.

ImportantBeforeyoucanuseWindowsAuthenticationtoconnecttoaMicrosoftSQLServerdatabase,theserveradministratormustconfiguretheservertousethismodeofauthentication,andmustgrantloginaccesstoyourWindowsuseraccount(oragroupofwhichyouruseraccountisamember)aswellastheaccountsofanyusersyouwanttoaccessyoursolution.Additionally,theserveradministratorshouldgiveusers'accountstheminimumlevelofpermissionstothetablesorstoredproceduresrequiredforyoursolution.

1. Inthedesignwindow,makesurethespreadsheetisactivated.Forinstructions,seeHelpforyourdesignprogram.

2. ClickCommandsandOptionsonthetoolbar,andthenclicktheDataSourcetab.

3. ClickEdit,andthendouble-clickNewSQLServerConnection.

4. InServername,specifythenameoftheserver.

5. UnderLogoncredentials,clickUseWindowsAuthentication.

6. ClickNext,andthenfollowthedirectionsinremainingscreensoftheDataConnectionWizardtospecifythedatatoretrieve.

Notes

SomedesignprogramsdonotsupporttheSpreadsheet'sdesign-timeuserinterfacebydefault.Ifyouareusingsuchaprogram,theDataSourcetabwillnotbedisplayedinstep2.Toactivatethedesign-timeuserinterface,youmustsettheDisplayDesignTimeUIpropertytoTrue.

OtherdatasourcesthatsupportWindowsAuthenticationmaypresentdifferentoptionsintheDataConnectionWizard.Forexample,to

connecttoanOracledatabaseusingWindowsAuthentication,youmustenteronlyaforwardslash(/)intheUserNamebox.FormoreinformationusingWindowsAuthenticationtoconnecttoadatasource,seethedocumentationforthedatasourceprovideryouareusing.

IfyouusetheDataRetrievalServiceforMicrosoftSQLServer(oruseaDataRetrievalServiceConnections(.uxdc)filethatisdefinedtousethatdataretrievalservice)toconnecttoanexternaldatasource,andyoudonotuseWindowsAuthentication,theusernameandpasswordusedtoconnecttothedatasourcearenotsavedintheWebpage.Whenyouusethismethodtoconnecttoanexternaldatasource,usersoftheWebPagethathostsyourspreadsheetwillbepromptedtoentertheirlogininformation.Touseadataretrievalservice,youmusthaveaccesstoaWindowsSharePointServicesserveronwhichthatdataretrievalserviceisinstalled.Bydefault,WindowsSharePointServicesinstallsadataretrievalserviceforconnectingtodatainSharePointlists.ASharePointsiteadministratorcaninstalltheOffice2003WebPartsandComponentstoadddataretrievalservicesforMicrosoftSQLServerandMicrosoftBusinessSolutions.TheOffice2003WebPartsandComponentsisavailablefromDownloadsonMicrosoftOfficeOnline.Tostartdefiningaconnectionusingadataretrievalservice,instep2intheprocedureabove,clickEdit,clickNewSource,andthenclickeitherMicrosoftBusinessSolutions(toconnecttoMicrosoftBusinessSolutionsdata)orclickDataretrievalservices(toconnecttoWindowsSharePointServiceslistsorMicrosoftSQLServerdata).

DefiningaConnectiontoExternalDataProgrammaticallyWhenworkingwiththeConnectionStringpropertytodefinetheconnectiontoanexternaldatasource(ordefiningtheconnectionstringforanADOConnectionobjecttopasstotheConnectionpropertyofthePivotTableobject),youshoulduseWindowsAuthenticationifpossible.TouseWindowsAuthenticationwithSQLServer,yourconnectionstringshouldusethisformat,whichincludesIntegratedSecurity=SSPI:

Provider=SQLOLEDB;DataSource=NameOfServer;InitialCatalog=NameOfDatabaseIntegratedSecurity=SSPI

Otherdatasourcesmayrequireadifferentformatfortheirconnectionstrings,forexampletoconnecttoanOracledatabaseusingWindowsAuthenticationrequiresyoutopassaforwardslash(/)fortheUserIDvalue:

Provider=MSDAORA.1;UserID=/;DataSource=NameOfServer;InitialCatalog=NameOfDatabase

WorkingwithDataSourcesthatDoNotSupportWindowsAuthenticationIfWindowsAuthenticationisnotavailableforthedatasourceyouwanttoworkwith,youmustpassausernameandpasswordtoconnecttothedatasourcewhenyoudefineaconnectioneitherprogrammaticallyorintheuserinterfaceofanOfficeWebcomponent.BecausethisusernameandpasswordmightbeviewedwhentheSpreadsheet,Chart,orPivotTablecomponentisonaWebpage,avoidusingthismodeofauthenticationtoconnecttosensitivedatafromacomponentonaWebpage.Evenifyouarenotconcernedaboutunauthorizedusersviewingyourdata,youshouldconnectonlywithauseraccountthathaslimitedpermissionsonthedatasource.Forexample,whenconnectingtoaSQLServerdatabaseusingausernameandpassword,donotusetheSAaccountoranyotheraccountthathaselevatedpermissions,becauseanunauthorizedusermightbeabletousethisaccountandpasswordtoaccessotherdataontheserver.

CreatinganAccessibleChartWhenyoucreateanewchart,bydefaulttheHasSelectionMarksandAllowPropertyToolBoxpropertiesaresettoFalse.Asaresult,auserworkingwithachartusingonlyakeyboardcannotseewhenaniteminthechartisselected(HasSelectionMarks)andcannotdisplaytheCommandsandOptionsdialogboxforsettingpropertiesoftheselecteditem(AllowPropertyToolBox).Toenablethesefeaturestomakeachartmoreaccessibleforkeyboardusers,youcansetthesepropertiesmanuallyatdesigntimebyusingthefollowingprocedure.

EnableselectionmarksandtheCommandsandOptionsdialogbox

1. Right-clicktheclickthechartcontrol,andthenclickCommandsandOptions.

2. OntheShow/HidetabunderLetusersview,clickSelectionmarksandCommandsandOptionsdialogbox.

Alternatively,youcansetthesepropertiesprogrammaticallyasinthefollowingexample.

SubMake_Accessible()

'Showselectionmarksforindividualchartelements.Chartspace1.HasSelectionMarks=True

'AllowtheusertodisplaytheCommandsandOptionsdialogbox.Chartspace1.AllowPropertyToolbox=True

EndSub

AllGroupingDefsCollectionObject

Multipleobjects AllGroupingDefsGroupingDefPageFields

ContainsalloftheGroupingDefobjectsinthedatasourcecontrol.

UsingtheAllGroupingDefsCollectionTheDataSourceControlobject'sAllGroupingDefspropertyreturnsanAllGroupingDefscollection.

AllPageFieldsCollectionObject

Multipleobjects AllPageFieldsPageFieldMultipleobjects

ContainsallthePageFieldobjectsinthedatasourcecontrol.

UsingtheAllPageFieldsCollectionTheDataSourceControlobject'sAllPageFieldspropertyreturnsanAllPageFieldscollection.

BordersCollectionObject

Range BordersMultipleobjects

AcollectionoffourBorderobjectsthatrepresentthefourbordersofaworksheetrange.

UsingtheBordersCollectionTheRangeobject’sBorderspropertyreturnsaBorderscollection.

ChAxesCollection

ChChart ChAxesMultipleobjects

ThecollectionofChAxisobjectsthatrepresenttheaxesforasinglechart.Eachchartcanhaveuptosixteenaxes.

UsingtheChAxescollectionTheChChartobject’sAxespropertyreturnsaChAxescollection.

ChCategoryLabelsCollectionObject

ChAxis ChCategoryLabelsMultipleobjects

RepresentsacollectionofalltheChCategoryLabelobjectsforthespecifiedcategoryaxis.

UsingtheChCategoryLabelsCollectionObjectUsetheCategoryLabelspropertyoftheChAxisobjecttoreturnaChCategoryLabelscollection.ThefollowingexampledisplaysthenumberoflabelsforthecategoryaxisonthefirstchartinChartspace1.

SubDisplayItemCount

DimchtChart1DimchConstantsSetchConstants=Chartspace1.ConstantsSetchtChart1=Chartspace1.Charts(0)MsgBoxchChart1.Axes(chConstants.chAxisPositionCategory)_.CategoryLabels.ItemCount

EndSub

ChChartFieldsObject

ChDropZone ChChartFieldsMultipleobjects

Representsthefieldsthathavebeenaddedtoadropzone.ContainsacollectionofChChartFieldobjects.

UsingtheChChartFieldsobjectTheChDropZoneobject'sChartFieldspropertyreturnsaChChartFieldsobject.

ChChartsCollection

Multipleobjects ChChartsChChartMultipleobjects

ThecollectionofChChartobjectsinthechartworkspace.EachChChartobjectrepresentsasinglechart.Thechartworkspacecancontainupto64charts.

UsingtheChChartscollectionTheChartSpaceobject’sChartspropertyreturnsaChChartscollection.

ChDataLabelsCollectionCollection

ChSeries ChDataLabelsCollectionMultipleobjects

RepresentsthecollectionofChDataLabelsobjectsforadataseries.EachChDataLabelsobjectrepresentsasetofdatalabelsforadataseries.

UsingtheChDataLabelsCollectioncollectionUsetheDataLabelsCollectionpropertyoftheChSeriesobjecttoreturnaDataLabelsCollectioncollection.

UsetheAddmethodoftheChDataLabelsCollectioncollectiontoaddasetofdatalabelstoadataseries.

ThefollowingexampleaddsdatalabelstothefirstseriesinthefirstchartinChartspace1,andthenformatsthedatalabels.

SubAddDataLabels()

DimserSeries1DimdlSeries1Labels

'Setavariabletothefirstseriesofthefirstchart'inChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasetofdatalabelstothefirstseriesandreturn'aDataLabelsobject.SetdlSeries1Labels=serSeries1.DataLabelsCollection.Add

'Setthenumberformatofthedatalabels.dlSeries1Labels.NumberFormat="0.00"

'Setthedatalabelstodisplaythecategory'nameforthedatapoint.dlSeries1Labels.HasCategoryName=True

'Setthedatalabelstodisplaythevalue'forthedatapoint.dlSeries1Labels.HasValue=True

EndSub

ChErrorBarsCollectionObject

ChSeries ChErrorBarsCollectionMultipleobjects

ThecollectionofChErrorBarsobjectsforasingleseries.

UsingtheChErrorBarsCollectionobjectTheChSeriesobject’sErrorBarsCollectionpropertyreturnsaChErrorBarsCollectionobject.

ThefollowingexampleaddserrorbarstothefirstseriesinthefirstchartinChartSpace1,thensetsthepropertiesfortheerrorbars.

SubAddErrorBars()

DimchConstantsDimebCollectionDimebSeries1

SetchConstants=ChartSpace1.Constants

'Setavariabletothecollectionoferrorbarsfor'thefirstseriesinthefirstchartofChartspace1.SetebCollection=ChartSpace1.Charts(0).SeriesCollection(0).ErrorBarsCollection

'Adderrorbarstothechart.ebCollection.Add

'Setavariabletotheerrorbarsforthedataseries.SetebSeries1=ebCollection.Item(0)

'Settheerrorbarssothattheyrepresentacertain'percentageofthevalueofadatapoint.ebSeries1.Type=chConstants.chErrorBarTypePercent

'Theerrorbarsrepresent5%ofadatapoint.ebSeries1.Amount=0.05

EndSub

ChLegendEntriesCollection

ChLegend ChLegendEntriesMultipleobjects

ThecollectionofChLegendEntryobjectsforthespecifiedlegend.

UsingtheChLegendEntriescollectionTheChLegendobject’sLegendEntriespropertyreturnsaChLegendEntriescollection.

UseLegendEntries(index),whereindexisthelegendentryindexnumber,toreturnasingleLegendEntryobject.Youcannotreturnlegendentriesbyname.

Theindexnumberrepresentsthepositionofthelegendentryinthelegend.LegendEntries(0)isatthetopofthelegend,andLegendEntries(LegendEntries.Count-1)isatthebottom.Thefollowingexamplechangesthefontforthetextofthelegendentryatthetopofthechartspacelegend(thisisusuallythelegendforseriesone)inChartspace1.

Chartspace1.ChartSpaceLegend.LegendEntries(0)_.Font.Bold=True

ChPointsCollection

ChSeries ChPointsMultipleobjects

AcollectionofalltheChPointobjectsinadataseries.Thenumberofdatapointsinaseriesislimitedonlybytheamountofsystemmemoryinthecomputerbeingused.

UsingtheChPointscollectionTheChSeriesobject’sPointspropertyreturnsaChPointscollection.

UsePoints(index),whereindexisthepointindexnumber,toreturnasingleChPointobject.Pointsarenumberedfromlefttorightontheseries.Points(0)istheleftmostpoint,andPoints(Points.Count-1)istherightmostpoint.ThefollowingexamplestoresthevalueofthethirdpointinthefirstdataseriesofthefirstchartinChartspace1inavariable.

SubGetPointValue()

DimptSeries1PointsDimdblPointValue

'Setavariabletothecollectionofpointsforthefirst'datasertiesinthefirstchartinChartspace1.SetptSeries1Points=ChartSpace1.Charts(0).SeriesCollection(0).Points

'Storetheunderlyingvalueofthethirddatapointinavariable.dblPointValue=ptSeries1Points(2).GetValue(chDimValues)

EndSub

ChSelectionCollectionCollection

Multipleobjects ChSelectionCollection

UsingtheChSelectionCollectionCollectionYouusetheSelectionCollectionpropertytoretrievetheselectionlist.TheSelectionCollectionpropertyoftheChartSpaceobject(forexample,ChartSpace.SelectionCollection)returnsaChSelectionCollectioncollectionthatcontainsallselectedobjectsinachart,includingbothprimaryandsecondaryselections.Theprimaryselectionisthefirstiteminthiscollection.Anyadditionalitemsaresecondaryselections,whichcanonlybeChPointobjects.Thiscollectionalwayscontainsatleastoneitem,whichistheprimaryselection.TheobjectreturnedbyChartSpace.SelectionCollection(0)isthesameobjectthatisreturnedbytheSelectionpropertyoftheChartSpaceobject(forexample,ChartSpace.Selection).TheChSelectionCollectioncollectioncanonlybepopulatedbyusingtheSelect2method,forexample,Chartspace.Charts(0).Seriescollection(x),Points(y).Select2().MultipleitemscannotbeselectedintheuserinterfaceoftheChartcomponent.Itemsmustbeaddedtoorremovedfromaselectionprogrammatically.Tocapturemultipleselectionswhenauserclicksonachart,youmustmonitorthemousemoveandmousebuttoneventsandidentifytheitemsbeingselectedusingtheRangeFromPointmethodoftheChartSpaceobject.Topreventthebuilt-inselectionhandlingbehavioroftheChartcomponentfrominterferingwithprogrammatictrackingofmultipleselections,youmustmakesurethattheAllowUISelectionpropertyoftheChartSpaceobjectissettoFalse.

YouusetheItempropertytoreturnasingleselectedobjectfromtheChSelectionCollectioncollection.IndividualobjectsintheChSelectionCollectioncollectionareindexedbeginningwith0forthefirstobject,1forthesecondobject,andsoforth.YouusetheCountpropertytoreturnthenumberofitemsintheChSelectionCollectioncollection.TheParentpropertyreturnstheparentobject,whichistheChartSpaceobjectinthiscase.

TheChSelectionCollectioncollectionhasnomethods.

ChSeriesCollectionCollectionObject

ChChart ChSeriesCollectionMultipleobjects

AcollectionofalltheChSeriesobjectsonachart.Achartcancontainupto256series.

UsingtheChSeriesCollectionCollectionObjectTheChChartobject’sSeriesCollectionpropertyreturnsaChSeriesCollectioncollection.

UsetheAddmethodtocreateanewseriesandaddittothechart.

UseSeriesCollection(index),whereindexistheseriesindexnumberorname,toreturnasingleChSeriesobject.ThefollowingexamplesetsthecoloroftheinteriorforthefirstseriesinthefirstchartofChartSpace1.

ChartSpace1.Charts(0).SeriesCollection(1).Interior.Color="Red"

ChTrendlinesCollection

ChSeries ChTrendlinesMultipleobjects

ThecollectionofChTrendlineobjectsforaseries.

UsingtheChTrendlinescollectionTheTrendlinespropertyoftheChSeriesobjectreturnsaChTrendlinescollection.

UsetheAddmethodoftheChTrendlineobjecttoaddatrendlinetoyourchart.

ThefollowingexampleaddsatrendlinetothefirstseriesinthefirstchartinChartspace1andthenformatsthetrendline.

SubAddPolyTrendline()

DimserSeries1DimchConstantsDimtlSeries1Trend

SetchConstants=ChartSpace1.Constants

'Setavariabletothefirstseriesofthefirstchart'inChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addatrendlinetothefirstseriesandreturn'aTrendlineobject.SettlSeries1Trend=serSeries1.Trendlines.Add

'Displaytheequationusedtocalculatethetrendline.tlSeries1Trend.IsDisplayingEquation=True

'Setthetrendlinetobeapolynomialtrendline.tlSeries1Trend.Type=chConstants.chTrendlineTypePolynomial

EndSub

DataPagesCollectionObject

Multipleobjects DataPagesDataPageMultipleobjects

ContainsallDataPageobjectsinthedatasourcecontrol.

UsingtheDataPagesCollectionTheDataSourceControlobject'sDataPagespropertyreturnsaDataPagescollection.

ElementExtensionsCollectionObject

Multipleobjects ElementExtensionsElementExtension

ContainstheElementExtensionobjectsforthespecifieddatasourcecontrol.

UsingtheElementExtensionsCollectionTheDataSourceControlobject'sElementExtensionspropertyreturnsanElementExtensionscollection.

FiltersCollectionObject

AutoFilter FiltersMultipleobjects

RepresentsthecollectionoffiltersusedwiththeAutoFilter.EachfilterisrepresentedbyaFilterobject.TheAutoFilterobjectcontainsaFilterscollection,theFilterscollectioncontainsaFilterobjectforeachcolumninthefilteredrange,andeachFilterobjectcontainsaCriteriaobject.

UsingtheFiltersObjectTheAutoFilterobject’sFilterspropertyreturnsaFilterscollection.

GroupingDefsCollectionObject

RecordsetDef GroupingDefsGroupingDefPageFields

RepresentsthecollectionofGroupingDefobjectsthatcreategroupingparentsofthedetailrecordsinarecordsetdefinition.Sequenceisimportant:thelowertheindex,thehigherthelevelofgrouping.Index0(zero)isthelowestgroupinglevel.

UsingtheGroupingDefsCollectionTheRecordsetDefobject'sGroupingDefspropertyreturnsaGroupingDefscollection.

GroupLevelsCollectionObject

Multipleobjects GroupLevelsGroupLevel

RepresentsthecollectionofGroupLevelobjectsforthespecifieddatasourcecontrol.EachGroupLevelobjectrepresentsthesetofallrecordsatagivenlevelofthedataaccesspagehierarchy.

UsingtheGroupLevelsCollectionTheDataSourceControlobject'sGroupLevelspropertyreturnsaGroupLevelscollection.

HeadingsObject

Window HeadingsMultipleobjects

AcollectionoftherowandcolumnheadingsforaWindowobject.

UsingtheHeadingsobjectThefollowingpropertiesreturnaHeadingscollection.

TheWindowobject'sRowHeadingsproperty.

TheWindowobject'sColumnHeadingsproperty.

ThefollowingexamplecustomizestheheadingofcolumnDintheactivesheetinSpreadsheet1:

Spreadsheet1.ActiveWindow.ColumnHeadings(4).Caption="1999Sales"

ListObjectsCollection

Worksheet ListObjectsMultipleobjects

UsingtheListObjectsCollectionTheListObjectscollectionisacollectionofalltheListObjectobjectsonaworksheet.AListObjectobjectrepresentsanXMLlistinaSpreadsheetcomponent.TheListObjectobjectisamemberoftheListObjectscollection.

IndividualListObjectobjectsintheListObjectscollectionareindexedbeginningwith1forthefirstobject,2forthesecondobject,andsoforth.YouusetheItempropertytoreturnasingleListObjectobjectfromtheListObjectscollection.TheargumentfortheItempropertyisthenameortheindexnumberintheListObjectscollectionoftheListObjectobject.ThenameisthevalueoftheIDattributeofanMapInfo/Map/EntryinanXMLSpreadsheetfile.TheXMLfragmentwherethesedetailsappearintheXMLSpreadsheetfilelookssomethinglikethefollowing:

<x2:MapInfoxmlns:x2="http://schemas.microsoft.com/office/excel/2003/xml"><x2:Mapx2:ID="Cust_MapId"><x2:Entryx2:ID="example_id"x2:Type="table">...</x2:Entry></x2:Map></x2:MapInfo>

Intheexampleabove,theIDvalueisexample_id.YoucanalsogetthenamebyusingtheNamepropertyoftheListObjectobject.UsingMicrosoftExcel,youcancreateanXMLSpreadsheetfilebycreatingadataboundspreadsheetandthensavingtheworkbookasanXMLSpreadsheet.

Youusetheread-onlyCountpropertytoreturnthenumberofobjectsintheListObjectscollection.UsingtheApplicationandParentpropertieswillreturntheSpreadsheetcomponentandtheparentobject(whichistheWorksheetobject)forthespecifiedListObjectscollection.

ListRowsCollection

ListObject ListRowsMultipleobjects

UsingtheListRowsCollectionTheListRowscollectionisacollectionofalltheListRowobjectsinaListObjectobject.AListObjectobjectrepresentsanXMLlistinaSpreadsheetcomponent.TheListRowobjectisamemberoftheListRowscollection.

IndividualListRowobjectsintheListRowscollectionareindexedbeginningwith1forthefirstobject,2forthesecondobject,andsoforth.YouusetheItempropertytoreturnasingleListRowobjectfromtheListRowscollection.TheargumentfortheItempropertyistheindexnumberintheListRowscollectionoftheListRowobject.

YoucreateanewrowintheListRowscollectionbypromotingthecellsintheinsertrowtoan"official"row.Todothis,youusetheAddmethod,whichreturnsaListRowobjectrepresentingthenewlycreatedrow.ThenewrowwillbeaddedtothebottomoftheXMLlist.

Youusetheread-onlyCountpropertytoreturnthenumberofobjectsintheListRowscollection.TheApplicationandParentpropertiesreturntheSpreadsheetcomponentandtheparentobject(whichistheListObjectobject)forthespecifiedListRowsobject.

LookupRelationshipsCollectionObject

PageRowsource LookupRelationshipsPageRelationshipMultipleobjects

RepresentsthecollectionofPageRelationshipobjectsthatdefinealookupjoinrelationshipwithapagerowsource.Intheobjectdiagramshowninthistopic,thefirstPageRowsourceobject(abovetheLookupRelationshipscollection)istheobjectonthe“many”sideoftheone-to-manyrelationshipandthePageRelationshipobject(belowthecollection)istheobjectonthe“one”side.

UsingtheLookupRelationshipsCollectionThePageRowsourceobject'sLookupRelationshipspropertyreturnsaLookupRelationshipscollection.

LookupSchemaRelationshipsCollectionObject

SchemaRowsource LookupSchemaRelationshipsSchemaRelationshipSchemaRelatedFields

RepresentsthecollectionofSchemaRelationshipobjectsforwhichasingleschemarowsourceactsasthe“many”sideoftheone-to-manyrelationship.

UsingtheLookupSchemaRelationshipsCollectionTheSchemaRowsourceobject'sLookupSchemaRelationshipspropertyreturnsaLookupSchemaRelationshipscollection.

NamesCollection

Multipleobjects NamesNameRange

AcollectionofalltheNameobjectsintheworkbook.EachNameobjectcanrepresentadefinednameforarangeofcells,aformula,oraconstantsvalue.

UsingtheNamescollectionUsetheNamespropertytoreturntheNamescollection.Thefollowingexamplecreatesalistofallthenamesintheactiveworkbook,alongwiththeaddressestowhichtheyrefer.

SubList_All_Names()DimnmCurrentNameDimrngCurrent

SetrngCurrent=Spreadsheet1.ActiveSheet.Range("A1")

'Loopthroughallofthenamesintheactiveworkbook.ForEachnmCurrentNameInSpreadsheet1.ActiveWorkbook.Names

'Writethecurrentnametotheworksheet.rngCurrent.Value=nmCurrentName.Name

'Writethedefinitionofthecurrentnametotheworksheet.rngCurrent.Offset(0,1).Value="'"&nmCurrentName.RefersTo

SetrngCurrent=rngCurrent.Offset(1,0)NextEndSub

UsetheAddmethodtocreateanameandaddittothecollection.ThefollowingexamplecreatesanewnamethatreferstocellsA1:C20ontheworksheetnamed"Sheet1."

Spreadsheet1.Names.Add"CurrentMonth","=Sheet1!$A$1:$C$20"

TheRefersToargumentmustbespecifiedinA1-stylenotation,including

dollarsigns($)whereappropriate.Forexample,ifcellA10isselectedonSheet1andyoudefineanamebyusingtheRefersToargument"=Sheet1!A1:B1",thenewnameactuallyreferstocellsA10:B10(becauseyouspecifiedarelativereference).Tospecifyanabsolutereference,use"=Sheet1!$A$1:$B$1".

OCCommandsObject

Multipleobjects OCCommandsOCCommand

ContainsacollectionofOCCommandobjectsthatrepresentthecollectionofalloftheuserinterfaceandkeyboardcommandsthatareavailableinthespecifiedMicrosoftOfficeWebComponent.

UsingtheOCCommandsobjectThefollowingpropertiesreturnaOCCommandscollection:

TheChartSpaceobject'sCommandsproperty.

ThePivotTableobject'sCommandsproperty.

TheSpreadsheetobject'sCommandsproperty.

TheOCCommandId,ChartCommandIdEnum,PivotCommandId,andSpreadsheetCommandIdconstantscontainlistsofthesupportedcommandsforeachWebcomponent.

UsetheItempropertytoreturnasingleOCCommandobject.

PageFieldsCollectionObject

Multipleobjects PageFieldsPageFieldMultipleobjects

ThecollectionofPageFieldobjectsdescribingthefieldsthatwillbepresentintherecordsetproducedbythespecifiedrecordsetdefinition.Thesefieldsareacombinationofoutputfieldsfromthepagerowsourcesthatmakeupthisrecordsetdefinitionandotherpagefieldsthatareaddedtothiscollection.Sequencewithinthiscollectionisunimportantbecauseallcontrolsbindbynameratherthanbytheirordinalrelationshiptofieldsintheoutputrecordset.

UsingthePageFieldsCollectionObjectTheRecordsetDef,PageRowSource,andGroupingDefobjects'PageFieldspropertyreturnsaPageFieldscollection.

PageRelatedFieldsCollectionObject

PageRelationship PageRelatedFieldsPageRelatedFieldPageField

ThecollectionofPageRelatedFieldobjectsthatbelongtoagivenrecordsetdefinition.ThiscollectionisautomaticallyfilledwhenarecordsetdefinitionbasedontheSchemaRelatedFieldscollectioniscreated.

UsingthePageRelatedFieldsCollectionThePageRelationshipobject'sPageRelatedFieldspropertyreturnsaPageRelatedFieldscollection.

PageRowsourcesCollectionObject

RecordsetDef PageRowsourcesPageRowsourceMultipleobjects

ThecollectionofPageRowsourceobjectsinthedatamodel.

UsingthePageRowsourcesCollectionObjectTheRecordsetDefobject'sPageRowsourcespropertyreturnsaPageRowsourcescollection.

PanesCollectionObject

Window PanesMultipleobjects

ThecollectionofPaneobjectsforaworksheet.

UsingthePanesCollectionTheWindowobject’sPanespropertyreturnsaPanescollection.

ParameterValuesCollectionObject

RecordsetDef ParameterValuesParameterValue

ThecollectionofParameterValueobjectsforarecordsetdefinition.

UsingtheParameterValuesCollectionTheRecordsetDefobject'sParameterValuespropertyreturnsaParameterValuescollection.

PivotAggregatesCollectionObject

PivotCell PivotAggregatesPivotAggregateMultipleobjects

ThecollectionofPivotAggregateobjectsforthespecifiedcell.

UsingthePivotAggregatesCollectionThePivotCellobject’sAggregatespropertyreturnsanobjectfromthePivotAggregatescollection.

PivotAxisMembersCollection

Multipleobjects PivotAxisMembersPivotAxisMemberMultipleobjects

AcollectionofPivotAxisMemberobjects.

UsingthePivotAxisMemberscollectionUsetheItempropertyofthePivotAxisMemberscollectiontoreturnaPivotAxisMemberobject.

PivotColumnMembersCollection

Multipleobjects PivotColumnMembersPivotColumnMemberMultipleobjects

AcollectionofPivotColumnMemberobjects.

UsingthePivotColumnMembersCollectionUsetheItempropertyofthePivotColumnMemberscollectiontoreturnaPivotColumnMemberobject.

PivotFieldsCollectionObject

Multipleobjects PivotFieldsPivotFieldMultipleobjects

ThecollectionofPivotFieldobjectsinthespecifiedfieldset.

UsingthePivotFieldsCollectionUsetheFieldspropertyofthefollowingobjectstoreturnaPivotFieldscollection:PivotDetailRange,PivotFieldSet,PivotResultColumnAxis,PivotResultDataAxis,PivotResultGroupAxis,PivotResultPageAxis,orPivotResultRowAxis.

PivotFieldSetsCollectionObject

Multipleobjects PivotFieldSetsPivotFieldSetMultipleobjects

ThecollectionofPivotFieldSetobjectsonthespecifiedaxisorinthespecifiedview.

UsingthePivotFieldSetsCollectionThefollowingpropertiesreturnanobjectfromthePivotFieldSetscollection:

ThePivotAxisobject’sFieldSetsproperty

ThePivotDataAxisobject’sFieldSetsproperty

ThePivotFilterAxisobject’sFieldSetsproperty

ThePivotGroupAxisobject’sFieldSetsproperty

ThePivotResultFilterAxisobject'sFieldSetsproperty

ThePivotViewobject’sFieldSetsproperty

PivotMemberPropertiesCollection

PivotField PivotMemberPropertiesPivotMemberProperty

AcollectionofPivotMemberPropertyobjects.

UsingthePivotMemberPropertiescollectionUsetheItempropertyofthePivotMemberPropertiescollectiontoreturnaPivotMemberPropertyobject.

PivotMembersCollectionObject

Multipleobjects PivotMembersPivotMemberMultipleobjects

AcollectionofPivotMemberobjects.

UsingthePivotMembersCollectionThefollowingpropertiesreturnanobjectfromthePivotMemberscollection:

TheChildMemberspropertyofthefollowingobjects:PivotAxisMember,PivotColumnMember,PivotMember,PivotPageMember,orPivotRowMember

ThePivotFieldobject’sCustomGroupMembersproperty

PivotPageMembersCollection

PivotPageMember PivotPageMembersPivotPageMemberMultipleobjects

AcollectionofPivotPageMemberobjects.

UsingthePivotPageMembersCollectionUsetheItempropertyofthePivotPageMemberscollectiontoreturnaPivotPageMemberobject.

PivotResultGroupFieldsCollection

Multipleobjects PivotResultGroupFieldsPivotResultGroupFieldMultipleobjects

AcollectionofPivotResultGroupFieldobjects.

UsingthePivotResultGroupFieldscollectionThefollowingpropertiesreturnaPivotResultGroupFieldscollection:

ThePivotResultColumnAxisobject'sGroupFieldsproperty.

ThePivotResultGroupAxisobject'sGroupFieldsproperty.

ThePivotResultPageAxisobject'sGroupFieldsproperty.

ThePivotResultRowAxisobject'sGroupFieldsproperty.

PivotResultMemberPropertiesCollection

Multipleobjects PivotResultMemberPropertiesPivotResultMemberPropertyPivotMemberProperty

Thecollectionofmemberpropertiesforaresultmember.

UsingthePivotResultMemberPropertiescollectionThefollowingpropertiesreturnaPivotResultMemberPropertiescollection:

ThePivotAxisMemberobject'sMemberPropertiesproperty.

ThePivotColumnMemberobject'sMemberPropertiesproperty.

ThePivotPageMemberobject'sMemberPropertiesproperty.

ThePivotRowMemberobject'sMemberPropertiesproperty.

PivotRowMembersCollection

Multipleobjects PivotRowMembersPivotRowMemberMultipleobjects

AcollectionofPivotRowMemberobjects.

UsingthePivotRowMembersCollectionUsetheItempropertyofthePivotRowMemberscollectiontoreturnaPivotRowMemberobject.

PivotTotalsCollectionObject

Multipleobjects PivotTotalsPivotTotalMultipleobjects

ThecollectionofPivotTotalobjectsonthespecifieddataaxisorinthespecifiedview.

UsingthePivotTotalsCollectionThePivotDataAxis,PivotResultDataAxis,andPivotViewobjects'TotalspropertyreturnsaPivotTotalscollection.

RecordsetDefsCollectionObject

Multipleobjects RecordsetDefsRecordsetDefMultipleobjects

ThecollectionofRecordsetDefobjectsforthespecifieddatasourcecontrol.

UsingtheRecordsetDefsCollectionTheDataSourceControlobject'sRecordsetDefspropertyreturnaRecordsetDefscollection.

SchemaFieldsCollectionObject

SchemaRowsource SchemaFieldsSchemaFieldSchemaProperties

ThecollectionofallavailableSchemaFieldobjectsinaschemarowsource.

UsingtheSchemaFieldsCollectionTheSchemaRowsourceobject'sSchemaFieldspropertyreturnsaSchemaFieldscollection.

SchemaParametersCollectionObject

SchemaRowsource SchemaParametersSchemaParameterSchemaProperties

ThecollectionofSchemaParameterobjectsforthespecifiedschemarowsource.

UsingtheSchemaParametersCollectionTheSchemaRowsourceobject'sSchemaParameterspropertyreturnsaSchemaParameterscollection.

SchemaRelationshipsCollectionObject

Multipleobjects SchemaRelationshipsSchemaRelationshipSchemaRelatedFields

ThecollectionofSchemaRelationshipobjectsforadatasourcecontrol.

UsingtheSchemaRelationshipsCollectionTheDataSourceControlobject'sSchemaRelationshipspropertyreturnsaSchemaRelationshipscollection.

SchemaRowsourcesCollectionObject

Multipleobjects SchemaRowsourcesSchemaRowsourceMultipleobjects

ThecollectionofSchemaRowsourceobjectsforthespecifieddatasourcecontrol.Thiscollectionisautomaticallyrepopulatedwithobjectsinthedatabasewheneverthedatabaseisopened.

UsingtheSchemaRowsourcesCollectionTheDataSourceControlobject'sSchemaRowsourcespropertyreturnsaSchemaRowsourcescollection.

SheetsCollection

Multipleobjects SheetsWorkbook

AcollectionofalltheWorksheetobjectsintheworkbook.EachWorksheetobjectrepresentsaworksheet.

UsingtheSheetscollectionThefollowingpropertiesreturnaSheetscollection.

TheSpreadsheetobject'sSheetsproperty.

TheWindowobject'sSelectedSheetsproperty.

TheWorkbookobject'sSheetsproperty.

SublistRelationshipsCollectionObject

RecordsetDef SublistRelationshipsPageRelationshipMultipleobjects

ThecollectionofPageRelationshipobjectsoftypedscSublistthatallhavethesamerecordsetdefinitionastheir“one”side(parent)ofaone-to-manyrelationship.Recordsinthechildofasublistrelationshipareretrievedonlywhentheyareneeded.

UsingtheSublistRelationshipsCollectionTheRecordsetDefobject'sSublistRelationshipspropertyreturnsaSublistRelationshipscollection.

SublistSchemaRelationshipsCollectionObject

SchemaRowsource SublistSchemaRelationshipsSchemaRelationshipSchemaRelatedFields

ThecollectionofSchemaRelationshipobjectsthatallhavethesameschemarowsourceastheir“one”side(fromaone-to-manyrelationship).

UsingtheSublistSchemaRelationshipsCollectionTheSchemaRowsourceobject'sSublistSchemaRelationshipspropertyreturnsaSublistSchemaRelationshipscollection.

WindowsCollectionObject

Multipleobjects WindowsWindowMultipleobjects

AcollectionofalltheWindowobjectsintheSpreadsheetcontrol.TheWindowscollectionfortheSpreadsheetobjectcontainsallthewindowsintheapplication,whereastheWindowscollectionfortheWorkbookobjectcontainsonlythewindowsinthespecifiedworkbook.Inbothcases,theSpreadsheetobjectcontainsonlyoneWindowobject.Thisobjectrepresentsthewindowforactivesheetwithintheworkbook.

EachsheethasadistinctWindowobjectassociatedwithit.Application.ActiveWindoworApplication.Workbooks(1).Windows(1)alwaysreturnsapointertotheactivesheet'swindow.ThereisnoActiveSheet.WindoworSheets(i).Window.

UsingtheWindowsCollectionObjectThefollowingpropertiesreturnaWindowscollection.

TheSpreadsheetobject'sWindowsproperty

TheWorkbookobject'sWindowsproperty.

WorkbooksCollection

Multipleobjects WorkbooksMultipleobjects

AcollectioncontainingtheWorkbookobjectthatisopeninthespreadsheetcontrol.Thespreadsheetcontrolsupportsonlyoneopenworkbook.

UsingtheWorkbookscollectionUsetheActiveWorkbookpropertytorefertotheworkbookthatiscurrentlyopeninthespreadsheetcontrol.

WorksheetsCollectionObject

Multipleobjects WorksheetsWorkbook

AcollectionofalltheWorksheetobjectsintheworkbook.EachWorksheetobjectrepresentsaworksheet.

UsingtheWorksheetsCollectionObjectUsetheWorksheetspropertyofSpreadsheetorWorkbookobjecttoreturntheWorksheetscollection.

UsetheAddmethodtocreateanewworksheetandaddittothecollection.ThefollowingexampleaddstwonewworksheetsbeforesheetoneofSpreadsheet1.

Spreadsheet1.Worksheets.Add_Spreadsheet1.Worksheets(1),,2

UseWorksheets(index),whereindexistheworksheetindexnumberorname,toreturnasingleWorksheetobject.ThefollowingexamplehidesworksheetoneintheSpreadsheet1.

Spreadsheet1.Worksheets(1).Visible=False

TheWorksheetobjectisalsoamemberoftheSheetscollection.

XmlDataBindingsCollection

Workbook XmlDataBindingsWorkbook

TheXmlDataBindingscollectioncontainsalloftheXmlDataBindingobjectsassociatedwithaSpreadsheetcomponent.EachXmlDataBindingobjectcontainsconfigurationdatathatbindstheSpreadsheetcomponenttoadataretrievalservice,SOAPWebService,XMLfile,oraWebPart.

UsingtheXmlDataBindingsCollectionTheXMLDataBindingobjectisamemberoftheXmlDataBindingscollection,whichisacollectionofalloftheXmlDataBindingobjectsinaSpreadsheetcomponent.Withinthecollection,individualXmlDataBindingobjectsareindexedbeginningwith1forthefirstobject,2forthesecond,andsoon.YoucanreturnaXmlDataBindingobjectfromtheXmlDataBindingscollectionbyusingtheItempropertyofthecollection.TheargumentfortheItempropertyistheindexinthecollectionoftheobjectyouwanttoreturnorthebindingIDoftheobject.ThebindingIDisthevalueoftheIDattributeintheXMLthatrepresentsthebinding.YoucanfindthisintheXMLSpreadsheetfilefortheSpreadsheetcomponent(orSpreadsheetWebPart)orbyexaminingtheBindingDatapropertyoftheXmlDataBindingobject.YoucancreateanXMLSpreadsheetfilebycreatingadataboundspreadsheetusingMicrosoftExcelandthensavingtheworkbookasanXMLSpreadsheet.

YoucreateanewXmlDataBindingobjectusingtheAddmethodoftheXmlDataBindingscollection.OnceyouhavecreatedtheXmlDataBindingobject,youcanuseitsBindingDatapropertytospecifybindingconfigurationinformationandyoucanusetheXmlMappropertytospecifytheschemamapassociatedwiththebinding.

ThefollowingexamplecreatestheXmlDataBindingsobjectusingtheXmlDataBindingspropertyoftheWorkbookobjectandshowshowtoworkwiththebindinginformation:

DimobjBindingsDimobjBindingDimstrBindingInfo

SetobjBindings=Spreadsheet1.ActiveWorkbook.XmlDataBindings

ForEachobjBindinginobjBindings

'SavetheXMLbindinginformationtoavariable.strBindingInfo=objBinding.BindingData'Workwiththebindinginformationhere.Next

XmlMapsCollection

Workbook XmlMapsWorkbook

TheXmlMapscollectionisacollectionofalloftheXmlMapobjectsassociatedwithaSpreadsheetcomponent.AnXmlMapobjectisanXMLschemamapthatspecifieshowtomapdatafromadatasourcetotheSpreadsheetcomponent.

UsingtheXmlMapsCollectionIntheXmlMapscollection,individualXmlMapobjectsareindexedbeginningwith1forthefirstobject,2forthesecondobject,andsoon.YoureturnaXmlMapobjectfromtheXmlMapscollectionusingtheItemproperty.TheargumentfortheItempropertyistheindexinthecollectionoftheobjectyouwanttoreturnorthemapIDoftheobject.ThemapIDisthevalueoftheIDattributeintheXMLthatrepresentsthemap.YoucanfindthisintheXMLSpreadsheetfileforthepartorbyexaminingtheMapDatapropertyoftheXmlMapobject.YoucancreateanXMLSpreadsheetfilebycreatingadata-boundspreadsheetinMicrosoftExcelandthensavingtheworkbookasanXMLSpreadsheet.YoucancreateanewXmlMapobjectbyusingtheAddmethodoftheXmlMapscollection.

ThefollowingexampleusestheXmlMapspropertytoreturntheXmlMapscollectionobject:

DimobjMapsDimobjMapDimstrMapInfo

SetobjMaps=Spreadsheet1.ActiveWorkbook.XmlMaps

ForEachobjMapinobjMaps'SavetheXMLmapinformationtoavariable.strMapInfo=objMap.MapData'Workwiththemapinformationhere.Next

AutoFilterObject

Multipleobjects AutoFilterMultipleobjects

RepresentstheAutoFiltercontainer.TheAutoFilterobjectcontainsaRangecollectionandaFilterscollection.

UsingtheAutoFilterObjectTheWorksheetobject’sAutoFilterpropertyreturnstheAutoFilterobjectforthespecifiedworksheet.

BorderObject

Range BordersBorderRange

Representstheborderofanobject.

TheBorderobjectisamemberoftheBorderscollection.

UsingtheBorderObjectTheBorderscollection’sItempropertyreturnsaBorderobject.

ByRefObject

ByRef

Containsthevalueofaneventparameter.

UsingtheByRefobjectSomeeventsreturnorsetvaluesthroughparametersthataretypedasByRefobjects.WhenaneventparameteristypedasaByRefobject,usetheValuepropertyoftheparametertoreturnorsettheparameter.

ThefollowingeventparametersreturnorsetvaluesthroughaByRefobject:

TheBeforeContextMenuevent'sMenuandCancelparameters

TheBeforeKeyDownevent'sCancelparameter

TheBeforeKeyPressevent'sCancelparameter

TheBeforeKeyUpevent'sCancelparameter

TheBeforeRenderevent'sCancelparameter

TheCommandBeforeExecuteevent'sCancelparameter

TheCommandCheckedevent'sCheckedparameter

TheCommandEnabledevent'sEnabledparameter

TheCommandTipTextevent'sCaptionparameter

TheEndEditevent'sFinalValue,Cancel,andErrorDescriptionparameters

TheStartEditevent'sInitialValue,Cancel,andErrorDescriptionparameters(Spreadsheet)

TheStartEditevent'sInitialValue,ArrowMode,CaretPosition,Cancel,andErrorDescriptionparameters(PivotTable)

ChartSpaceObject

ChartSpace Multipleobjects

Representsthechartworkspace.Thechartworkspaceisthetop-levelchartcontainer;itcancontainmorethanonechart,witheachchartrepresentedbyaChChartobject.Whenachartworkspaceisfirstcreated,itisempty(itdoesnotcontainanycharts).UsetheAddmethodoftheChChartsobjecttocreateanewchart.

UsingtheChartSpaceObjectYoucanuseeithertheCreateObjectmethodortheNewkeywordtocreateanewChartSpaceobject.

TheobjectIDforachartcontrolonanHTMLpageoraVisualBasicformreturnsaChartSpaceobject.

TheprogrammaticidentifierfortheChartSpaceobjectisCLSID:0002E55D-0000-0000-C000-000000000046.Thefollowingexamplecreatesachartworkspacenamed"ChartSpace1"onanHTMLpage.

<objectid=ChartSpace1classid=CLSID:0002E55D-0000-0000-C000-000000000046style="width:100%;height:350"></object>

ChAxisObject

Multipleobjects ChAxisMultipleobjects

Representsasingleaxisonachart.Achartcanhaveuptosixteenaxes.TheChAxisobjectisamemberoftheChAxescollection.

UsingtheChAxisobjectUsetheChAxesobject’sAddmethodtoaddanaxistoachart.

ThefollowingpropertiesandmethodsreturnaChAxisobject.

TheChAxesobject’sAddmethod

TheChAxesobject’sItemproperty

TheChAxisobject’sCrossingAxisproperty

TheChGridlinesobject’sParentproperty

ChBorderObject

Multipleobjects ChBorder

Representstheborderofanobjectonachart.

UsingtheChBorderobjectThefollowingpropertiesreturnaChBorderobject:

TheChChartobject'sBorderproperty

TheChChartDrawobject'sBorderproperty

TheChDataLabelobject'sBorderproperty

TheChDataLabelsobject'sBorderproperty

TheChDropZoneobject'sButtonBorderproperty

TheChDropZoneobject'sWatermarkBorderproperty

TheChLegendobject'sBorderproperty

TheChPlotAreaobject'sBorderproperty

TheChPointobject'sBorderproperty

TheChSegmentBoundaryobject'sBorderproperty

TheChSeriesobject'sBorderproperty

TheChSurfaceobject'sBorderproperty

TheChTitleobject'sBorderproperty

UsetheColor,DashStyle,andWeightpropertiestosettheattributesofaborder.ThefollowingexamplesetsborderpropertiesforthelegendofChartSpace1.

SubFormat_Chartspace_Legend()

DimChartLegendDimchConstants

SetchConstants=ChartSpace1.Constants

'Setavariabletothelegendforthechartspace.

SetChartLegend=ChartSpace1.ChartSpaceLegend

'Setthelegendcolor.ChartLegend.Border.Color="Blue"

'Setthelineweightforthelegend.ChartLegend.Border.Weight=chConstants.owcLineWeightThick

'Setthelinestyleforthelegend.ChartLegend.Border.DashStyle=chLineRoundDot

EndSub

ChCategoryLabelObject

Multipleobjects ChCategoryLabelMultipleobjects

RepresentsasinglelabelinaChCategoryLabelscollection.

UsingtheChCategoryLabelobjectYoucanusethefollowingpropertiestoreturnaChCategoryLabelobject:

TheItempropertyoftheChCategoryLabelscollection

TheParentLabelpropertyoftheChCategoryLabelobject

ChChartObject

Multipleobjects ChChartMultipleobjects

Representsasinglechartinthechartworkspace.Thechartworkspacecancontainupto16charts.TheChChartobjectisamemberoftheChChartscollection.

UsingtheChChartObject

UsetheChChartscollectionobject’sAddmethodtoaddacharttothechartworkspace:

ThefollowingpropertiesandmethodsreturnaChChartobject.

TheChAxesobject’sParentproperty

TheChAxisobject’sParentproperty

TheChChartsobject’sAddmethod

TheChChartsobject’sItemproperty

TheChPlotAreaobject’sParentproperty

TheChSeriesobject’sParentproperty

TheChSeriesCollectionobject’sParentproperty

ChChartDrawObject

ChChartDraw Multipleobjects

Canbeusedtodrawitemsonachart,suchasaline,rectangle,orellipse.

UsingtheChChartDrawobjectTheDrawEllipse,DrawLine,DrawPolyLine,DrawPolygon,DrawLinemethodscanbeusedtoadddrawingobjectstoachart.TheDrawTextmethodcanbeusedtoaddtexttoachart.TheBorder,Font,Interior,andLinepropertiescanbeusedtoformateachdrawingobjectbeforeitisaddedtothechart.

Youmustutilizeoneormoreofthefollowingeventstoaddadrawingobjecttoachart:BeforeRender,AfterRender,orAfterFinalRender.

ChChartFieldObject

ChDropZone ChChartFieldsChChartFieldChDropZone

Representsafieldinadropzone.

UsingtheChChartFieldobjectTheChChartFieldsobject'sItempropertyreturnsaChChartFieldobject.

Accessingthisobjectwhenyourchartisboundtoliteraldatawillresultinarun-timeerror.

UnsupportedLanguageElementYouhaverequestedHelpforalanguageelementthatisnotsupported.

ChDataLabelObject

Multipleobjects ChDataLabelMultipleobjects

Representsasingledatalabelforaseries,orthesingledatalabelforatrendline.

UsingtheChDataLabelobjectThefollowingpropertiescanbeusedtoreturnaChDataLabelobject:

TheChDataLabelsobject'sItemproperty

TheChTrendlineobject'sDataLabelproperty

ThefollowingexampleaddsdatalabelstothefirstseriesinthefirstchartinChartspace1,andthenformatsthethirddatalabel.

SubFormatSeriesLabel()

DimserSeries1DimdlSeries1Labels

'Setavariabletothefirstseriesofthefirstchart'inChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasetofdatalabelstothefirstseriesandreturn'aDataLabelsobject.SetdlSeries1Labels=serSeries1.DataLabelsCollection.Add

dlSeries1Labels.Item(2).Font.Bold=TruedlSeries1Labels.Item(2).Font.Color="Red"

EndSub

ChDataLabelsObject

Multipleobjects ChDataLabelsMultipleobjects

ContainsacollectionofChDataLabelobjectsthatrepresentallthedatalabelsinthespecifiedsetofdatalabelsforaseries.Notethataseriescancontainmorethanonesetofdatalabels.

UsingtheChDataLabelsobjectThefollowingmethodsandpropertiescanbeusedtoreturnaChDataLabelsobject:

TheChDataLabelsCollectioncollectionobject'sAddmethod.

TheChDataLabelsCollectioncollectionobject'sItemproperty.

ThefollowingexampleaddsdatalabelstothefirstseriesinthefirstchartinChartspace1andthenformatsthedatalabels.

SubAddDataLabels()

DimserSeries1DimdlSeries1Labels

'Setavariabletothefirstseriesofthefirstchart'inChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasetofdatalabelstothefirstseriesandreturn'aDataLabelsobject.SetdlSeries1Labels=serSeries1.DataLabelsCollection.Add

'Setthenumberformatofthedatalabels.dlSeries1Labels.NumberFormat="0.00"

'Setthedatalabelstodisplaythecategory'nameforthedatapoint.dlSeries1Labels.HasCategoryName=True

'Setthedatalabelstodisplaythevalue'forthedatapoint.dlSeries1Labels.HasValue=True

EndSub

ChDropZoneObject

Multipleobjects ChDropZoneMultipleobjects

Representsadropzoneonchartsthatareboundtoarelationaldatasource.

UsingtheChDropZoneobjectTheChartSpaceobject'sDropZonesmethodreturnsaChDropZoneobject.

ThefollowingexampleformatsthebuttonandthewatermarkoftheseriesdropzoneinChartspace1.

SubSetup_DropZone()

DimdzSeriesDropZoneDimChConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Thenextthreelinesofcodeformatthebuttonofthedropzone.dzSeriesDropZone.ButtonBorder.Weight=chConstants.owcLineWeightMediumdzSeriesDropZone.ButtonInterior.SetSolid"Red"dzSeriesDropZone.ButtonFont.Size=14

'Thenextthreelinesofcodeformatthewatermarkofthedropzone.dzSeriesDropZone.WatermarkBorder.Color="Red"dzSeriesDropZone.WatermarkFont.Color="Red"dzSeriesDropZone.WatermarkInterior.SetSolid"Green"

EndSub

ChErrorBarsObject

ChSeries ChErrorBarsCollectionChErrorBarsMultipleobjects

Representstheerrorbarsforaseries.Errorbarsindicatethedegreeofuncertaintyforchartdata.OnlyseriesinRadar,Polar,Area,Bar,Column,Line,andXY(Scatter)chartscanhaveerrorbars.Onlyseriesinscatterchartscanhavexandyerrorbars.TheChErrorBarsobjectisnotacollection.Thereisnoobjectthatrepresentsasingleerrorbar;youeitherhavexerrorbarsoryerrorbarsturnedonforallpointsinaseriesoryouhavethemturnedoff.

UsingtheChErrorBarsobjectUsetheAddmethodoftheChErrorBarsCollectionobjecttoadderrorbarstoaseries.

ThefollowingmethodsreturnaChErrorBarsobject.Formoreinformation,seetheHelptopicsforthesemethods:

TheChErrorBarsCollectionobject’sAddmethod

TheChErrorBarsCollectionobject’sItemproperty

ThefollowingexampleaddserrorbarstothefirstseriesinthefirstchartinChartSpace1,andthensetsthepropertiesfortheerrorbars.

SubAddErrorBars()

DimchConstantsDimebCollectionDimebSeries1

SetchConstants=ChartSpace1.Constants

'Setavariabletothecollectionoferrorbarsfor'thefirstseriesinthefirstchartofChartspace1.SetebCollection=ChartSpace1.Charts(0).SeriesCollection(0).ErrorBarsCollection

'Adderrorbarstothechart.ebCollection.Add

'Setavariabletotheerrorbarsforthedataseries.SetebSeries1=ebCollection.Item(0)

'Settheerrorbarssothattheyrepresentacertain'percentageofthevalueofadatapoint.

ebSeries1.Type=chConstants.chErrorBarTypePercent

'Theerrorbarsrepresent5%ofadatapoint.ebSeries1.Amount=0.05

EndSub

ChFontObject

Multipleobjects ChFont

Containsthefontattributes(fontname,fontsize,color,andsoon)foranobjectonachart.

UsingtheChFontobjectThefollowingpropertiescanbeusedtoreturnaChFontobject:

TheChAxisobject'sFontproperty

TheChChartDrawobject'sFontproperty

TheChDataLabelobject'sFontproperty

TheChDataLabelsobject'sFontproperty

TheChDropZoneobject'sButtonFontproperty

TheChDropZoneobject'sWatermarkFontproperty

TheChLegendobject'sFontproperty

TheChLegendEntryobject'sFontproperty

TheChTitleobject'sFontproperty

UsetheNamepropertytosetthefontforaparticularobject.TheBold,Italic,Color,Underline,andSizepropertiescanbeusedtofurtherformatthefontofaparticularobject.

ChFormatMapObject

Multipleobjects ChFormatMapChSegments

TheChFormatMapobjectallowsformattingtorepresentarangeofdatavalues.TheChFormatMapobjectcanbeusedprovidevisualcuesthathighlightcertainportionsofyourdata.

UsingtheChFormatMapobjectTheFormatMappropertyoftheChSeriesobjectreturnsaChFormatMapobject.

FormatmapscontainoneormoreChSegmentobjects,eachofwhichcanbeformattedindependently.

ThefollowingexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreated.Thesmallervaluesaredisplayedinwhite,thenlargervaluesaredisplayedinalightshadeofblue,andfinallythelargestvaluesinthechartaredisplayedindarkblue.

SubWindow_Onload()

DimserSeries1DimsegSegment1DimchConstants

SetchConstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;PersistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=ServerName;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderdetailstable.ChartSpace1.SetDatachConstants.chDimCategories,chConstants.chDataBound,"ProductID"ChartSpace1.SetDatachConstants.chDimValues,chConstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachConstants.chDimFormatValues,chConstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.SetsegSegment1=serSeries1.FormatMap.Segments.Add

'Specifythatthedivisionsinformattingbecreatedautomatically.segSegment1.HasAutoDivisions=True

'Measurethesegmentboundariesbaseduponapercentage.segSegment1.Begin.ValueType=chConstants.chBoundaryValuePercentsegSegment1.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto100%.segSegment1.Begin.Value=0segSegment1.End.Value=1

'Formattheinteriorofthematchingvalues.segSegment1.Begin.Interior.Color="White"segSegment1.End.Interior.Color="Blue"

EndSub

ThefollowingexamplebindsChartspace1totheOrderDetailstableintheNorthwinddatabase.Then,twosegmentsarecreated.Thefirstsegmenthighlightsthelowest10%ofvaluesinthefirstseriesinthechart.Thesecondsegmenthighlightsthetop20%ofvaluesinthefirstseriesinthechart.

SubWindow_Onload()

Dimserseries1DimsegBottom10PctDimsegTop20PctDimchConstants

SetchConstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;PersistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=ServerName;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderdetailstable.ChartSpace1.SetDatachConstants.chDimCategories,chConstants.chDataBound,"ProductID"ChartSpace1.SetDatachConstants.chDimValues,chConstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachConstants.chDimFormatValues,chConstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.Setserseries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.Thissegmentwill'representthebottom10%ofvaluesinthechart.SetsegBottom10Pct=serseries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segBottom10Pct.Begin.ValueType=chConstants.chBoundaryValuePercentsegBottom10Pct.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto10%.

segBottom10Pct.Begin.Value=0

segBottom10Pct.End.Value=0.1

'Formattheinteriorofthematchingvalues.segBottom10Pct.Begin.Interior.Color="red"segBottom10Pct.End.Interior.Color="red"

'Addasegmenttotheformatmap.Thissegmentwill'representthetop20%ofvaluesinthechart.SetsegTop20Pct=serseries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segTop20Pct.Begin.ValueType=chConstants.chBoundaryValuePercentsegTop20Pct.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto80%,andtheendingvalueto100%.segTop20Pct.Begin.Value=0.8segTop20Pct.End.Value=1

'Formattheinteriorofthematchingvalues.segTop20Pct.Begin.Interior.Color="green"segTop20Pct.End.Interior.Color="green"

EndSub

ChGridlinesObject

ChAxis ChGridlinesMultipleobjects

Representsmajororminorgridlinesonachartaxis.Youcannothavegridlineswithoutanaxis.Gridlinesextendthetickmarksonachartaxistomakeiteasiertoseethevaluesassociatedwiththedatamarkers.Thisobjectisnotacollection.Thereisnoobjectthatrepresentsasinglegridline;youeitherhaveallgridlinesforanaxisturnedonorallofthemturnedoff.

UsingtheChGridlinesobjectThefollowingpropertiesreturnaChGridlinesobject.

TheChAxisobject’sMajorGridlinesproperty

TheChAxisobject’sMinorGridlinesproperty

ThefollowingexampleenablesthemajorandminorgridlinesforthevalueaxisinthefirstchartinChartspace1.Then,theweightofthegridlinesisformatted.

SubEnableGridlines()

DimchConstantsDimaxValueAxis

SetchConstants=ChartSpace1.Constants

'SetavariabletothevalueaxisinthefirstchartinChartspace1.SetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)

'Thefollowingtwolinesofcodeturnonthemajorand'minorgridlinesforthevalueaxis.axValueAxis.HasMajorGridlines=TrueaxValueAxis.HasMinorGridlines=True

'Thefollowingtwolinesofcodesetthelineweightofthe'majorandminorgridlinesforthevalueaxis.axValueAxis.MajorGridlines.Line.Weight=chConstants.owcLineWeightMediumaxValueAxis.MinorGridlines.Line.Weight=chConstants.owcLineWeightHairline

EndSub

ChInteriorObject

Multipleobjects ChInterior

Representstheinteriorformattingofanobject.

UsingtheChInteriorobjectThefollowingpropertiesreturnaChInteriorobject:

TheChChartobject'sInteriorproperty

TheChChartDrawobject'sInteriorproperty

TheChartSpaceobject'sInteriorproperty

TheChDataLabelobject'sInteriorproperty

TheChDataLabelsobject'sInteriorproperty

TheChDropZoneobject'sButtonInteriorproperty

TheChDropZoneobject'sWatermarkInteriorproperty

TheChLegendobject'sInteriorproperty

TheChPlotAreaobject'sInteriorproperty

TheChPointobject'sInteriorproperty

TheChSegmentBoundaryobject'sInteriorproperty

TheChSeriesobject'sInteriorproperty

TheChSurfaceobject'sInteriorproperty

TheChTitleobject'sInteriorproperty

ThefollowingexamplesetstheinteriorfillofthefirsttwoseriesandtheplotareaofthefirstchartinChartSpace1.

SubFormatInteriorFills()

DimchConstantsDimserSeries1DimserSeries2

SetchConstants=ChartSpace1.Constants

SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)SetserSeries2=ChartSpace1.Charts(0).SeriesCollection(1)

'Settheinteriorfillofthefirstseriestoatwo-colorgradient.serSeries1.Interior.SetTwoColorGradientchConstants.chGradientDiagonalDown,_chConstants.chGradientVariantCenter,"Blue","Silver"

'Settheinteriorfillofthesecondseriestoasolidcolor.serSeries2.Interior.SetSolid"Purple"

'Settheinteriorfilloftheplotareatoapresettexture.ChartSpace1.Charts(0).PlotArea.Interior.SetTextured_chConstants.chTextureParchment,chConstants.chTile

EndSub

ChLegendObject

Multipleobjects ChLegendMultipleobjects

Representsachartworkspaceorchartlegend.Achartorchartworkspacecanhaveonlyonelegend.TheChLegendobjectcontainsaChLegendEntriescollectionthatcontainsoneormoreChLegendEntryobjects.

UsingtheChLegendobjectUsetheHasLegendpropertyortheHasChartSpaceLegendpropertytoenablethelegend.

ThefollowingpropertiesreturnaChLegendobject.

TheChartSpaceobject’sChartSpaceLegendproperty

TheChChartobject’sLegendproperty

TheChLegendEntriesobject’sParentproperty

TheChLegendEntryobject’sParentproperty

ChLegendEntryObject

ChLegend ChLegendEntriesChLegendEntryMultipleobjects

Representsasinglelegendentry.TheChLegendEntryobjectisamemberoftheChLegendEntriescollection.

UsingtheChLegendEntryobjectTheChLegendEntriescollection’sItempropertyreturnsaChLegendEntryobject.

UseLegendEntries(index),whereindexisthelegendentryindexnumber,toreturnasingleLegendEntryobject.Youcannotreturnlegendentriesbyname.

Theindexnumberrepresentsthepositionofthelegendentryinthelegend.LegendEntries(0)isatthetopofthelegend,andLegendEntries(LegendEntries.Count)isatthebottom.Thefollowingexamplechangesthefontforthetextofthelegendentryatthetopofthechartspacelegend(thisisusuallythelegendforseriesone)inChartspace1.

Chartspace1.ChartSpaceLegend.LegendEntries(0)_.Font.Bold=True

ChLineObject

Multipleobjects ChLine

Representstheformattingofalineonachart.

UsingtheChLineobjectYoucanusethefollowingpropertiestoreturnaChLineobject:

TheChAxisobject'sLineproperty

TheChChartDrawobject'sLineproperty

TheChErrorBarsobject'sLineproperty

TheChGridlinesobject'sLineproperty

TheChPointobject'sLineproperty

TheChSegmentBoundaryobject'sLineproperty

TheChSeriesobject'sLineproperty

TheChTrendlineobject'sLineproperty

ChMarkerObject

ChSeries ChMarker

RepresentsadatamarkeronaLine,XY(Scatter),Radar,orPolarchart.

UsingtheChMarkerobjectTheChSeriesobject’sMarkerpropertyreturnsaChMarkerobject.

UsetheSizeandStylepropertiestoformatChMarkerobjects.

ThefollowingexampleconvertsthefirstseriesinthefirstchartofChartspace1toalinechart,andthenformatsthemarkersontheline.

SubFormatMarkers()

DimserSeries1DimchConstants

SetchConstants=ChartSpace1.Constants

'Setavariabletothefirstseriesofthefirstchart'inChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Changethetypeofthefirstdataseriestoalinechart.serSeries1.Type=chConstants.chChartTypeLineMarkers

'Setthemarkerstyle.serSeries1.Marker.Style=chConstants.chMarkerStyleDiamond

'Setthesizeofthemarkers.serSeries1.Marker.Size=7

EndSub

ChPlotAreaObject

Multipleobjects ChPlotAreaMultipleobjects

Representstheplotareaonachart(theareawherethechartdataisplotted).Pie,Doughnut,Radar,andPolarchartsdonothaveaplotarea;instead,thesechartsdrawdirectlyonthechartarea.

UsingtheChPlotAreaobjectTheChChartobject’sPlotAreapropertyreturnsaChPlotAreaobject.

ThefollowingexamplefillstheplotareaofthefirstchartinChartspace1withapredefinedtexture.

SubFormatPlotArea()DimchConstants

SetchConstants=ChartSpace1.Constants

'Settheinteriorfilloftheplotareatoapresettexture.ChartSpace1.Charts(0).PlotArea.Interior.SetTextured_

chConstants.chTextureParchment,chConstants.chTile

EndSub

ChPointObject

ChSeries ChPointsChPointMultipleobjects

Representsasingledatapointinaseriesonachart.TheChPointobjectisamemberoftheChPointscollection,whichcontainsallthepointsinagivenseries.

UsingtheChPointobjectUsethisobjecttoformatsingledatapointsinaseries,orusetheGetValuemethodtoreturnapointvalue.

TheChPointsobject’sItempropertyreturnsaChPointobject.

ChScalingObject

Multipleobjects ChScaling

Representsthescalingforadataseries,axis,orchart.

UsingtheChScalingobjectThefollowingpropertiesreturnaChScalingobject:

TheChAxisobject'sScalingproperty

TheChChartobject'sScalingsproperty

TheChSeriesobject'sScalingsproperty

ChScrollViewObject

ChChart ChScrollView

UsingtheChScrollViewObjectYouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationandtocontrolthescrollviewofachart.

YouusethetheScrollViewpropertyoftheChChartobjecttoretrievetheChScrollViewobjectofthechart(oneperchart.)Thisobjectistheprimaryinterfacethatallowsapplicationstoretrieveinformationandcontrolthescrollview.TheChScrollViewobjecthasseveralpropertiesthatyoucanusetospecifyanddeterminethescrollviewofthechart.

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotareaanditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechartandtheremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.

TheVerticalPositionandHorizontalPositionpropertiesshiftthescrollviewverticallyandhorizontally.Theinitialvaluesofthesepropertiesaretreatedasthelocation(0,0),andarerelativetothevaluesoftheLeftandToppropertiesoftheactualplotarea(theChPlotAreaobject).TheincrementalshiftinthepositionofthescrollviewisrelativetotheratiooftheVerticalExtentandVerticalExtentMaxproperties,andtotheratiooftheHorizontalExtentandHorizontalExtentMaxproperties.

TheratiooftheVerticalExtentandVerticalExtentMaxpropertiesdescribesthepositionofthescrollviewarea’sverticaldimensionrelativetotheactualplotarea’sverticaldimension.TheratiooftheHorizontalExtentandHorizontalExtentMaxpropertiesvaluedescribesthepositionofthescrollviewarea’shorizontaldimensionrelativetotheactualplotarea’shorizontaldimension.

YoucanzoomthedisplayofthechartinoroutbysettingtheVerticalExtentMaxandHorizontalExtentMaxpropertiestovaluesgreaterorlessthantheVerticalExtentandHorizontalExtentproperties,respectively.Forexample,tozoomthechartby200%,setthe

VerticalExtentMaxandHorizontalExtentMaxpropertiestotwicethevalueoftheVerticalExtentandHorizontalExtentproperties.

Whetherthechartiszoomedornot,youcanaccessthescrollview’sdimensionsbyusingtheTop,Left,Right,andBottompropertiesoftheChScrollViewobject.And,youcanaccesstheactualplotarea’sdimensionsbyusingtheTop,Left,Right,andBottompropertiesoftheChPlotAreaobject.

IfthevalueofeithertheHorizontalExtentortheHorizontalExtentMaxpropertyislessthanorequaltozero(0),thescrollviewisdisabledandachartcannotbescrolledhorizontally.Similarly,achartcannotbescrolledverticallyifthevalueofeithertheVerticalExtentMaxortheVerticalExtentpropertyislessthanorequaltozero.

YoucanalsochangethescrollpositionandscrollextentusingtheSetPositionandSetExtentmethodsoftheChartcomponent.UsingtheSetPositionandSetExtentmethodsisthesameassettingtheindividualHorizontalExtent,VerticalExtent,HorizontalPosition,andVerticalPositionproperties,butthesemethodsallowyoutosetmultiplepropertiesatthesametimetoreducethenumberoftimesthechartisrepainted.

ChSegmentObject

ChFormatMap ChSegmentsChSegmentChSegmentBoundary

Representsasinglesegmentinaformatmap.Eachsegmentofaformatmapcanbeformattedindependentlyoftheothersegments.

UsingtheChSegmentobjectThefollowingmethodsandpropertiesreturnaChSegmentobject.

TheChSegmentsobject'sAddmethod

TheChSegmentsobject'sItemproperty

UsetheAddmethodoftheChSegmentsobjecttocreateanewsegment.UsethepropertiesoftheChSegmentBoundaryobjectreturnedbytheBeginpropertytoformatthebeginningofasegment.UsethepropertiesoftheChSegmentBoundaryobjectreturnedbytheEndpropertytoformattheendofasegment.

ExampleThefollowingexamplebindsChartspace1totheOrderDetailstableintheNorthwinddatabase.Then,twosegmentsarecreated.Thefirstsegmenthighlightsthelowest10%ofvaluesinthefirstseriesinthechart.Thesecondsegmenthighlightsthetop20%ofvaluesinthefirstseriesinthechart.

SubWindow_Onload()

Dimserseries1DimsegBottom10PctDimsegTop20PctDimchConstants

SetchConstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.

ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;persistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;DataSource="&_"ServerName;"

ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderdetailstable.ChartSpace1.SetDatachConstants.chDimCategories,chConstants.chDataBound,"ProductID"ChartSpace1.SetDatachConstants.chDimValues,chConstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachConstants.chDimFormatValues,chConstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.Setserseries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.Thissegmentwill'representthebottom10%ofvaluesinthechart.SetsegBottom10Pct=serseries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.

segBottom10Pct.Begin.ValueType=chConstants.chBoundaryValuePercentsegBottom10Pct.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto10%segBottom10Pct.Begin.Value=0segBottom10Pct.End.Value=0.1

'Formattheinteriorofthematchingvalues.segBottom10Pct.Begin.Interior.Color="red"segBottom10Pct.End.Interior.Color="red"

'Addasegmenttotheformatmap.Thissegmentwill'representthetop20%ofvaluesinthechart.

SetsegTop20Pct=serseries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segTop20Pct.Begin.ValueType=chConstants.chBoundaryValuePercentsegTop20Pct.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto80%,andtheendingvalueto100%.segTop20Pct.Begin.Value=0.8segTop20Pct.End.Value=1

'Formattheinteriorofthematchingvalues.segTop20Pct.Begin.Interior.Color="green"segTop20Pct.End.Interior.Color="green"

EndSub

ChSegmentBoundaryObject

ChSegment ChSegmentBoundaryMultipleobjects

RepresentstheboundariesofofaChSegmentobject.

UsingtheChSegmentBoundaryobjectThefollowingpropertiesreturnaChSegmentBoundaryobject.

TheChSegmentobject'sBeginproperty

TheChSegmentobject'sEndproperty

UsetheValuepropertytosetthebeginningandendingvaluesofaChSegmentBoundaryobject.UsetheValueTypepropertytospecifywhetheravaluerepresentsapercentageoranabsolutevalue.

UsetheobjectsreturnedbythefollowingpropertiestoformataChSegmentBoundaryobject:Border,Interior,andLine.

ChSegmentsObject

ChFormatMap ChSegmentsMultipleobjects

RepresentsthecollectionofsegmentsforaChFormatMapobject.

UsingtheChSegmentsobjectTheSegmentspropertyoftheChFormatMapobjectcanbeusedtoreturnaChSegmentsobject.

UsetheAddmethodoftheChSegmentsobjecttoaddasegmenttoaformatmap.

UsetheItempropertyoftheChSegmentsobjecttoreturnasingleChSegmentobject.

ChSeriesObject

Multipleobjects ChSeriesMultipleobjects

Representsaseriesonachart.TheChSeriesobjectisamemberoftheChSeriesCollectioncollection.

UsingtheChSeriesobjectUsetheAddmethodoftheChSeriesCollectioncollectiontoaddaseriestoachart.

ThefollowingpropertiesandmethodsreturnaChSeriesobject:

TheChDataLabelsobject’sParentproperty

TheChDataLabelsCollectionobject’sParentproperty

TheChErrorBarsobject’sParentproperty

TheChErrorBarsCollectionobject’sParentproperty

TheChPointobject’sParentproperty

TheChPointsobject’sParentproperty

TheChSeriesCollectionobject’sAddmethod

TheChSeriesCollectionobject’sItemproperty

TheChTrendlineobject’sParentproperty

TheChTrendlinesobject’sParentproperty

ChSurfaceObject

ChPlotArea ChSurfaceMultipleobjects

Representsthesurfaceofthewallsandfloorofachart.

UsingtheChSurfaceobjectThefollowingpropertiescanbeusedtoreturnaChSurfaceobject:

TheChChartobject'sBackWallproperty

TheChChartobject'sSideWallproperty

TheChChartobject'sFloorproperty

YoucanusetheBorder,Interior,andThicknesspropertiestoformataChSurfaceobject.

ChTitleObject

Multipleobjects ChTitleMultipleobjects

Representsthetitleofachartworkspace,axis,orchart.

UsingtheChTitleobjectUsetheHasTitleorHasChartspaceTitlepropertytoenabletitles.

ThefollowingpropertiesreturnaChTitleobject:

TheChartSpaceobject’sChartSpaceTitleproperty

TheChAxisobject’sTitleproperty

TheChChartobject’sTitleproperty

ThefollowingexampleaddsatitletothefirstchartinChartpsace1andthenformatsthenewly-createdtitle.

SubAddChartTitle()

DimChart1TitleDimchConstants

SetchConstants=ChartSpace1.Constants

'Enablethetitleforthefirstchartinthe'chartspace.ChartSpace1.Charts(0).HasTitle=True

'Setavariabletothecharttitle.SetChart1Title=ChartSpace1.Charts(0).Title

'Setthecaoptionforthetitle.Chart1Title.Caption="2000SalesbyDepartment"

'Setthetitletodisplayatthebottomofthechart.Chart1Title.Position=chConstants.chTitlePositionBottom

'Formatthefontusedforthetitle.

Chart1Title.Font.Bold=TrueChart1Title.Font.Name="Tahoma"Chart1Title.Font.Size=16

EndSub

ChTrendlineObject

ChSeries ChTrendlinesChTrendlineMultipleobjects

Representsatrendlineonachart.Atrendlineshowsthetrend,ordirection,ofdatainaseries.TheChTrendlineobjectisamemberoftheChTrendlinescollection.

UsingtheChTrendlineobjectUsetheAddmethodoftheChTrendlinesobjecttoaddatrendlinetoaseries.

ThefollowingmethodandpropertyreturnaChTrendlineobject.

TheChTrendlinescollection’sAddmethod

TheChTrendlinescollection’sItemproperty

ThefollowingexampleaddsatrendlinetothefirstseriesinthefirstchartinChartspace1andthenformatsthetrendline.

SubAddPolyTrendline()

DimserSeries1DimchConstantsDimtlSeries1Trend

SetchConstants=ChartSpace1.Constants

'Setavariabletothefirstseriesofthefirstchart'inChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addatrendlinetothefirstseriesandreturn'aTrendlineobject.SettlSeries1Trend=serSeries1.Trendlines.Add

'Displaytheequationusedtocalculatethetrendline.tlSeries1Trend.IsDisplayingEquation=True

'Setthetrendlinetobeapolynomialtrendline.tlSeries1Trend.Type=chConstants.chTrendlineTypePolynomial

EndSub

ChUserDefinedSelectionObject

ChUserDefinedSelection

RepresentsanobjectdrawnonthechartbetweencallstotheBeginObjectandEndObjectmethods.

UsingtheChUserDefinedSelectionobjectWhenacustomdrawingobjectisselected,theChartSpaceobject'sSelectionpropertyreturnsaChUserDefinedSelectionobject.

CoordinateObject

Coordinate

StorestheXandY-coordinatesofadatapointforlaterretrieval.

UsingtheCoordinateobjectUsetheValueToPointmethodoftheChAxisorChSeriesobjecttoreturnaCoordinateobject.

UsethexandypropertiesoftheCoordinateobjecttoreturntheXandY-coordinatesofthedatapointcurrentlystoredintheCoordinateobject.

ThefollowingexamplechangesthetitleofthefirstchartinChartspace1tothepixelcoordinatesofadatapointinthefirstseriesofthechart.

SubGetPixelCoordinates()

DimchChart1DimlXPosDimlYPosDimcoPointCoordinates

'SetavariabletothefirstchartinChartspace1.SetchChart1=ChartSpace1.Charts(0)

'Enablethetitleforthechart.chChart1.HasTitle=True

'SetaCoordinateobjecttothecoordinatesofadatapoint.SetcoPointCoordinates=chChart1.SeriesCollection(0).ValueToPoint("Pears",10)

'SetavariabletotheX-coordinate.lXPos=coPointCoordinates.x

'SetavariabletotheY-coordinate.lYPos=coPointCoordinates.y

'Setthechart'stitlestothepixelcoordinatesofthespecified

'datapoint.chChart1.Title.Caption="X("&lXPos&")Y("&lYPos&")"

EndSub

CriteriaObject

Filter CriteriaFilter

ContainstheentirearrayofAutoFiltercriteria.EachcriterionisaStringvalue.TheAutoFilterobjectcontainsaFilterscollection,theFilterscollectioncontainsaFilterobjectforeachcolumninthefilteredrange,andeachFilterobjectcontainsaCriteriaobject.

UsingtheCriteriaObjectTheFilterobject’sCriteriapropertyreturnstheCriteriaobjectforthespecifiedfilter.

DataPageObject

Multipleobjects DataPageMultipleobjects

Representsthecombinationofsectionsthatareshownonadataaccesspagewhentheexpandbuttonisclicked.Thesesectionsincludeacaptionsection,agroupheaderandgroupfootersectionforeachrecord,andanavigationsectioncorrespondingtothesetofvisiblerecordsfromarecordsetwithinasingleparentrecord.

TheDataPageobjectisamemberoftheDataPagescollection.

UsingtheDataPageObjectThefollowingpropertiesreturnaDataPageobject:

TheDataPagesobject'sItemproperty

TheSectionobject'sDataPageproperty

TheDSCEventInfoobject'sDataPageproperty

DataSourceControlObject

DataSourceControl Multipleobjects

Representsadatasourcecontrol.Thedatasourcecontrolisthetop-levelcontainerinthedatamodel.

UsingtheDataSourceControlObjectYoucanuseeithertheCreateObjectmethodortheNewkeywordtocreateaDataSourceControlobject.

TheobjectIDforadatasourcecontrolonanHTMLpagereturnsaDataSourceControlobject.TheprogrammaticidentifierfortheDataSourceControlobjectisCLSID:CLSID:0002E55B-0000-0000-C000-000000000046.Thefollowingexamplecreatesadatasourcecontrolnamed"MSODSC"onanHTMLpage.

<objectid=MSODSCclassid=CLSID:0002E55B-0000-0000-C000-000000000046></object>

DSCEventInfoObject

DSCEventInfo Multipleobjects

Containsinformationaboutthespecifieddatasourcecontrolevent.

UsingtheDSCEventInfoObjectThefollowingdatasourcecontroleventsuseaDSCEventInfoobjectastheironlyparameter:

TheAfterDeleteevent

TheAfterInsertevent

TheAfterUpdateevent

TheBeforeCollapseevent

TheBeforeDeleteevent

TheBeforeExpandevent

TheBeforeFirstPageevent

TheBeforeInitialBindevent

TheBeforeInsertevent

TheBeforeLastPageevent

TheBeforeNextPageevent

TheBeforeOverwriteevent

TheBeforePreviousPageevent

TheBeforeUpdateevent

TheCurrentevent

TheDataErrorevent

TheDataPageCompleteevent

TheDirtyevent

TheFocusevent

TheRecordExitevent

TheRecordsetSaveProgressevent

TheUndoevent

YoucanusethepropertiesoftheDSCEventInfoobjecttoreturninformationaboutthedataaccesspagewhenaneventistrapped.TheSectionpropertycanbeusedtodeterminethesectionofthedataaccesspagewheretheeventoccurred.YoucanusetheReturnValuepropertytocancelthecompletionofsomeevents.

TheeventslistedabovevaryintheirsupportoftheDSCEventInfoproperties.SomeoftheeventssupportasubsetoftheDSCEventInfoproperties,andsomeeventsdon'tsupportanyoftheDSCEventInfoproperties.Usinganunsupportedpropertywillresultinarun-timeerror.

ThefollowingexamplecancelsthedeletionofarecordiftheDiscontinuedfieldissettheNo.TheSectionpropertyoftheDSCEventInfoobjectisusedtodrilldowntothevalueoftheDiscontinuedfield.IfthefieldcontainsthevalueNo,thentheReturnValueoftheDSCEventInfoobjectissettoFalse,cancelingthedeletionoftherecord.

SubMSODSC_BeforeDelete(DSCEventInfo)

DimtxtDiscontinued

'Setavariabletothetextboxthatcontainsthevalue'oftheDiscontinuedfieldfortherecordthatistobedeleted.SettxtDiscontinued=DSCEventInfo.Section.HTMLContainer_.Children("Discontinued")

'Checkthevalueofthecontrol.IftxtDiscontinued.Value="No"Then

'Displayamessagetotheuser.Msgbox"Donotdeleteproductsthathavenot"&_"beendiscontinued."

Cancelthedeletionoftherecord.DSCEventInfo.ReturnValue=FalseEndIf

EndSub

ElementExtensionObject

Multipleobjects ElementExtensionsElementExtension

Addsdata-relatedpropertiestoHTMLelementssuchastextboxesanddrop-downlistboxes.ElementextensionstierecordsetandgroupingdefinitionobjectssuchaspagefieldstoanelementontheHTMLpagethatcanbeboundtotheirresultingdata.

TheElementExtensionobjectisamemberoftheElementExtensionscollection.

UsingtheElementExtensionObjectThefollowingmethodandpropertyreturnanElementExtensionobject:

TheElementExtensionscollection'sAddmethod

TheElementExtensionscollection'sItemproperty

FilterObject

Multipleobjects FilterMultipleobjects

RepresentsasinglefilterusedwiththeAutoFilter.TheFilterobjectisamemberoftheFilterscollection.TheAutoFilterobjectcontainsaFilterscollection,theFilterscollectioncontainsaFilterobjectforeachcolumninthefilteredrange,andeachFilterobjectcontainsaCriteriaobject.

UsingtheFilterObjectTheFiltersobject'sItempropertyreturnsaFilterobject.

FontObject

Multipleobjects Font

Containsthefontattributes(fontname,fontsize,color,andsoon)foranobject.

UsingtheFontobjectUsetheFontpropertytoreturnaFontobject.

ThefollowingexampleformatscellsA1:C5asbold.

Spreadsheet1.ActiveSheet.Range("A1:A5").Font.Bold=True

GroupingDefObject

Multipleobjects GroupingDefPageFields

Representsagroupingdefinition.Agroupingdefinitionisaspecialtypeofrecordsetdefinition.AswithRecordsetDefobjects,youcanuseagroupingdefinition'snameintheExecutemethodandintheRecordSourcepropertyofagrouplevelorelementextension.

AgroupingdefinitiondefinesanADOgroupingrecordsetthatappearsasaparentofthecontainingrecordsetinthehierarchyorrecordsetsproducedbyapage.Atruntime,allthedataforthecontainingrecordsetdefinitionisfetchedbeforethegroupingrecordsetiscreated.

UsingtheGroupingDefObjectThefollowingmethodsandpropertyreturnaGroupingDefobject:

TheGroupingDefscollection'sAddmethod

TheGroupingDefscollection'sAddTotalmethod

TheGroupingDefsorAllGroupingDefscollections'Itemproperty

GroupLevelObject

Multipleobjects GroupLevel

Representsthesetofallrecordsatagivenlevelofthedataaccesspagehierarchy.TheGroupLevelobjectisamemberoftheGroupLevelscollection.

UsingtheGroupLevelObjectThefollowingmethodandpropertyreturnaGroupLevelobject:

TheGroupLevelscollection’sAddmethod

TheGroupLevelscollection’sItemproperty

TheDataPageobject'sGroupLevelproperty

HeadingObject

Window HeadingsHeadingWindow

Representsasingleroworcolumnheaderinthespecifiedwindow'sHeadingscollection.

UsingtheHeadingobjectUsetheHeadingscollection'sItempropertytoreturnanindividualHeadingobject.ThiscanbeexpressedasHeadings(Index)orHeadings.Item(Index),whereIndexistheindexnumberoftheindividualHeadingobject.

UsetheCaptionpropertytocustomizetherowandcolumnheadingsinawindow.ThefollowingexampleillustrateshowtousetheCaptionpropertytochangetherowandcolumnheadinginawindow:

SubChange_Headings()

DimhdrColHeadingsDimhdrRowHeadings

'Setavariabletothecolumnheadingsintheactivewindow.SethdrColHeadings=Spreadsheet1.ActiveWindow.ColumnHeadings

'Setavariabletotherowheadingsintheactivewindow.SethdrRowHeadings=Spreadsheet1.ActiveWindow.RowHeadings

'SettheheadingsofcolumnsAthroughD.hdrColHeadings(1).Caption="Qtr1"hdrColHeadings(2).Caption="Qtr2"hdrColHeadings(3).Caption="Qtr3"hdrColHeadings(4).Caption="Qtr4"

'Settheheadingsofrows1though5.hdrRowHeadings(1).Caption="Sedan"hdrRowHeadings(2).Caption="Convertible"hdrRowHeadings(3).Caption="Truck"hdrRowHeadings(4).Caption="Sport-Utility"

hdrRowHeadings(5).Caption="Minivan"

EndSub

TheCaptionpropertyoftheHeadingobjectislimitedto256characters,andthetextcannotbewrappedtoasecondline.

UsetheResetHeadingsmethodtosettherowandcolumnheadingsbacktotheirdefaultvalues.

HyperlinkObject

Range HyperlinkRange

Representsahyperlink.

UsingtheHyperlinkObjectTheRangeobject’sHyperlinkpropertyreturnsaHyperlinkobject.

InteriorObject

Multipleobjects Interior

Representstheinteriorofanobject.

UsingtheInteriorObjectThefollowingpropertiesreturnanInteriorobject:

TheRangeobject’sInteriorproperty

TheTitleBarobject’sInteriorproperty

ListObjectObject

Multipleobjects ListObjectMultipleobjects

UsingtheListObjectObjectAListObjectobjectrepresentsanXMLlistonaworksheet.TheListObjectobjectisamemberoftheListObjectscollection.IndividualListObjectobjectsintheListObjectscollectionareindexedbeginningwith1forthefirstobject,2forthesecondobject,andsoon.YouusetheItempropertytoreturnasingleListObjectobjectfromtheListObjectscollection.TheargumentfortheItempropertyisthenameortheindexnumberintheListObjectscollectionoftheListObjectobject.ThenameisthevalueoftheIDattributeofanEntryelement(MapInfo/Map/Entry)inanXMLspreadsheetfile.TheXMLfragmentwherethesedetailsappearintheXMLSpreadsheetfilelookssomethinglikethefollowing:

<x2:MapInfoxmlns:x2="http://schemas.microsoft.com/office/excel/2003/xml"><x2:Mapx2:ID="Cust_MapId"><x2:Entryx2:ID="example_id"x2:Type="table">...</x2:Entry></x2:Map></x2:MapInfo>

YoucanalsogetthenamebyusingtheNamepropertyoftheListObjectobject.UsingMicrosoftExcel,youcancreateanXMLSpreadsheetfilebycreatingadataboundspreadsheetandthensavingtheworkbookasanXMLSpreadsheet.

ThisexamplesetsthelineweightoftheborderfortherangeofthespecifiedlistintheSpreadsheetcomponent.

SubSetListBorder()DimssConstantsDimrngList

SetssConstants=Spreadsheet1.Constants

'Setavariabletotherangethatcontainsthelist.SetrngList=Spreadsheet1.ActiveSheet.ListObjects(1).Range'Settherangeborderweight.rngList.Borders.Weight=ssConstants.owcLineWeightMediumEndSub

ListRowObject

ListObject ListRowsListRowMultipleobjects

UsingtheListRowObjectAListRowobjectrepresentsarowinaListObjectobjectinaSpreadsheetcomponent.TheListRowobjectisamemberoftheListRowscollection.TheListRowscollectioncontainsalltherowsinaListObjectobject.TheListRowobjecthasnodefaultproperty.

IndividualListRowobjectsintheListRowscollectionareindexedbeginningwith1forthefirstobject,2forthesecondobject,andsoforth.YouusetheItempropertytoreturnasingleListRowobjectfromtheListRowscollection.TheargumentfortheItempropertyistheindexnumberintheListRowscollectionoftheListRowobject.

YouusetheDeletemethodtodeletethecellsofarowinalist.Deletingtherowwillcauseashiftupfortheremainingcellsbelowthedeletedrow.Theread/writeActivepropertyoftheListRowobjectallowsyoutofindoutifarowisselectedortoselectit.YouusetheRangepropertytoreturnaRangeobjectthatrepresentstherangetowhichthespecifiedlistrowapplies.

YoufindoutthecurrentordinalpositionoftheListRowobjectintheListRowscollectionusingtheIndexproperty.TheApplicationandParentpropertiesreturntheSpreadsheetcomponentandtheparentobject(whichistheListObjectobject)forthespecifiedListRowsobject.

NameObject

Multipleobjects NamesNameRange

Representsadefinednameforarangeofcells,aformula,oraconstantvalue.TheNameobjectisamemberoftheNamescollection.

UsingtheNameobjectUseNames(index),whereindexisthename,indexnumberordefinedname,toreturnasingleNameobject.

Theindexnumberindicatesthepositionofthenamewithinthecollection.Thefollowingexampledisplaysthecellreferenceforthefirstnameintheapplicationcollection.

MsgBoxNames(1).RefersTo

Thefollowingexampledeletesthename"mySortRange"fromtheactiveworkbook.

ActiveWorkbook.Names("mySortRange").Delete

UsetheNamepropertytoreturnorsetthetextofthenameitself.ThefollowingexamplechangesthenameofthefirstNameobjectintheactiveworkbook.

Names(1).Name="stock_values"

UsetheAddmethodtocreateanameandaddittothecollection.ThefollowingexamplecreatesanewnamethatreferstocellsA1:C20ontheworksheetnamed"Sheet1."

Spreadsheet1.Names.Add"CurrentMonth","=Sheet1!$A$1:$C$20"

TheRefersToargumentmustbespecifiedinA1-stylenotation,includingdollarsigns($)whereappropriate.Forexample,ifcellA10isselectedonSheet1andyoudefineanamebyusingtheRefersToargument"=Sheet1!A1:B1",thenewnameactuallyreferstocellsA10:B10(becauseyouspecifiedarelativereference).Tospecifyanabsolutereference,use"=Sheet1!$A$1:$B$1".

OCCommandObject

Multipleobjects OCCommandsOCCommand

RepresentsasinglecommandinthespecifiedMicrosoftOfficeWebComponent.

UsingtheOCCommandobjectUsetheItempropertyoftheOCCommandscollectiontoreturnasingleOCCommandobject.

TheOCCommandId,ChartCommandIdEnum,PivotCommandId,andSpreadsheetCommandIdconstantscontainlistsofthesupportedcommandsforeachMicrosoftOfficeWebComponent.

UsetheExecutemethodoftheOCCommandobjecttoexecuteaparticularcommand.ThefollowingexampleusestheExecutemethodtoselecttheupper-leftcellintheactivesheetofSpreadsheet1.

SubSelectUpperLeft()

DimssConstants

SetssConstants=Spreadsheet1.Constants

'Selecttheupper-leftcellintheactiveworksheet.Spreadsheet1.Commands(ssConstants.ssCommandMoveToOrigin).Execute

EndSub

UsetheCommandBeforeExecuteeventtoimposecertainrestrictionsbeforeacommandisexecuted,ortocancelacommand.ThefollowingexamplerefreshesPivotTable1whentheExportcommandisinvokedsothatthelatestdataisexportedtoMicrosoftExcel.

SubPivotTable1_CommandBeforeExecute(Command,Cancel)

DimptConstants

SetptConstants=PivotTable1.Constants

'ChecktoseeiftheExportcommand'hasbeeninvoked.IfCommand=ptConstants.plCommandExportThen

'RefreshthePivotTablelist.PivotTable1.Refresh

EndIf

EndSub

Thefollowingexamplepreventstheuserfromcutting,copying,orexportingthecontentsofSpreadsheet1toMicrosoftExcel.

SubSpreadsheet1_CommandBeforeExecute(Command,Cancel)

DimssConstants

SetssConstants=Spreadsheet1.Constants

SelectCaseCommand

'ChecktoseeiftheExportcommandhas'beeninvoked.CasessConstants.ssCommandExport

'Cancelthecommand.Cancel.Value=True

'Displayamessagetotheuser.MsgBox"Exportofthedataisprohibited."

'ChecktoseeiftheCutorCopycommands

'havebeeninvoked.CasessConstants.ssCommandCopy,ssConstants.ssCommandCut

'Cancelthecommand.Cancel.Value=True

'Displayamessagetotheuser.MsgBox"CuttingorCopyingthedataisprohibited."EndSelect

EndSub

UsetheCommandExecuteeventwhenyouwanttoexecuteasetofcommandswhenaparticularcommandisexecuted.ThefollowingexamplewritesthecurrentdateandtimetoanHTMLtextboxcontroleverytimethatPivotTable1isrefreshed.

SubPivotTable1_CommandExecute(Command)

DimptConstants

SetptConstants=PivotTable1.Constants

'ChecktoseeifthePivotTablelisthasbeenrefreshed.IfCommand=ptConstants.plCommandRefreshThen

'Writethecurrentdataandtimetothetextbox.TextBox.Value="PivotTablelastrefeshedon"&_Date&"at"&Time

EndIf

EndSub

HiddenLanguageElementYouhaverequestedHelpforalanguageelementthatishidden,andthereforeunavailableforprogrammaticaccess.

OWCLanguageSettingsObject

Multipleobjects OWCLanguageSettings

ReturnsinformationaboutthelanguagesettingsfortheMicrosoftOfficeWebComponents.

UsingtheOWCLanguageSettingsobjectUseApplication.LanguageSettings.LanguageID(MsoAppLanguageID),whereMsoAppLanguageIDisoneofthefollowingconstantsusedtoreturnlocaleidentifier(LCID)informationtothespecifiedapplication:msoLanguageIDHelp,msoLanguageIDInstall,msoLanguageIDUI,ormsoLanguageIDUIPrevious.Thefollowingexamplereturnstheinstalllanguage,userinterfacelanguage,andHelplanguageLCIDsforaspreadsheetcontrolnamedSpreadsheet1inamessagebox.

MsgBox"ThefollowinglocaleIDsareregistered"&_"forthisapplication:InstallLanguage-"&_Spreadsheet1.LanguageSettings.LanguageID(msoLanguageIDInstall)&_"UserInterfaceLanguage-"&_Spreadsheet1.LanguageSettings.LanguageID(msoLanguageIDUI)&_"HelpLanguage-"&_Spreadsheet1.LanguageSettings.LanguageID(msoLanguageIDHelp)

ThefollowingexampletestswhethertheU.S.Englishlanguageisregisteredasapreferrededitinglanguage.

IfSpreadsheet1.LanguageSettings._LanguagePreferredForEditing(msoLanguageIDEnglishUS)ThenMsgBox"U.S.Englishisoneofthechoseneditinglanguages."EndIf

PageFieldObject

Multipleobjects PageFieldMultipleobjects

Representsafieldinarecordsetorgroupingdefinition.Thepagefieldnameisusedbyacontrolonadataaccesspagetobindtodatafromarecordset.

PageFieldobjectscomeinthreetypes:

Output.Thistypecomesdirectlyfromaschemafieldinaschemarowsource.Forschemarowsourcesofthetabletypeorviewtype,thismeansthefieldislistedintheSELECTlistoftheSQLstatementgeneratedbythedatamodel.Forschemarowsourcesofthetexttypeorstoredproceduretype,allschemafieldsappearasoutputandthepagefieldnamemustbethesameastheschemafieldname.

Calculated.Thisisalocallycalculatedcolumnaddedtoarecordset.VisualBasicforApplicationsexpressionsyntaxissupported.ExpressionscanreferencepagefieldsoftypedscOutputordscGroupingwithinthesamerecordsetdefinitionorgroupingdefinition.ExpressionscanalsoreferenceHTMLelementsbyusingthedocumentobjectmodel(forexample,=Quantity*UnitPrice*Document.All("Text0").Value).Calculatedfieldsarerecalculatedwheneveranupdatedrecordissaved,wheneverthepageisrefreshed,orwhenevertherecordset'sResyncmethodiscalled.

Grouping.ThisisagroupingfieldoraggregatefieldattachedtoaGroupingDeforRecordsetDefobject.

ThePageFieldobjectcanbeamemberoftheAllPageFields,GroupingFields,OutputFields,orPageFieldscollection.

UsingthePageFieldObjectThefollowingpropertiesandmethodreturnaPageFieldobject:

TheAllPageFieldscollection'sItemproperty

ThePageFieldscollection'sAddmethod

ThePageFieldscollection'sItemproperty

ThePageRelatedFieldobject'sManySideproperty

ThePageRelatedFieldobject'sOneSideproperty

PageRelatedFieldObject

PageRelationship PageRelatedFieldsPageRelatedFieldPageField

Representsapageinstanceofthecolumnpairingsthatmakeupapagerelationship.ThenamesofthesefieldsareusedingeneratingjoinclausesinSQLandinrelatingaparentrecordsetdefinitiontoachildrecordsetdefinition.

ThePageRelatedFieldobjectisamemberofthePageRelatedFieldscollection.

UsingthePageRelatedFieldObjectThePageRelatedFieldscollection'sItempropertyreturnsaPageRelatedFieldobject.

PageRelationshipObject

Multipleobjects PageRelationshipMultipleobjects

APageRelationshipobjecttiestwopagerowsourcestogether,eitherwithinarecordsetdefinition(aLookupRelationshipscollection)orbetweenrecordsetdefinitions(aSublistRelationshipscollection).ApagerelationshipiscreatedfrominformationinaSchemaRelationshipobject.

ThePageRelationshipobjectisamemberoftheLookupRelationshipsorSublistRelationshipscollection.

UsingthePageRelationshipObjectThefollowingmethodsandpropertiesreturnaPageRelationshipobject:

TheLookupRelationshipscollection'sAddmethod

TheLookupRelationshipscollection'sItemproperty

TheSublistRelationshipscollection'sAddmethod

TheSublistRelationshipscollection'sItemproperty

PageRowsourceObject

Multipleobjects PageRowsourceMultipleobjects

APageRowsourceobjectreferstoaninstanceofaSchemaRowsourceobjectthatiscurrentlyinuseonadataaccesspage.Atable,view,orstoredproceduremustbeinthedatamodelasaschemarowsourcebeforeitcanbeaddedasapagerowsource;thepagerowsourceisthenusedasadatasourceforthepage.

ThePageRowsourceobjectisamemberofthePageRowsourcescollection.

UsingthePageRowsourceObjectThefollowingpropertiesreturnaPageRowsourceobject:

ThePageFieldobject'sPageRowsourceproperty

ThePageRelationshipobject'sManySideproperty

ThePageRelationshipobject'sOneSideproperty

ThePageRowsourcescollection'sItemproperty

TheRecordsetDefobject'sPrimaryPageRowsourceproperty

PaneObject

Multipleobjects PaneMultipleobjects

Representsapaneinawindow.ThePaneobjectisamemberofboththePanescollectionandtheWindowobject.

UsingthePaneObjectThefollowingpropertiesreturnaPaneobject:

ThePanescollection’sItemproperty

TheWindowobject’sActivePaneproperty

ParameterValueObject

RecordsetDef ParameterValuesParameterValue

Representsaninputparametervalueexpression.Thisexpressionisevaluatedatexecutetimetoprovidearun-timeparametervaluetoarowsourceoftypedscProcedureordscCommandText.

UsingtheParameterValueObjectThefollowingmethodandpropertyreturnaParameterValueobject:

TheParameterValuescollection'sAddmethod

TheParameterValuescollection'sItemproperty

PivotAggregateObject

PivotCell PivotAggregatesPivotAggregateMultipleobjects

RepresentsthedataassociatedwithatotalinaPivotTablelist.Atotaldefineswhattheuserwantstosee,butthedatathatresultsfromthetotaliscalledtheaggregateoraggregatevalue.ThePivotAggregateobjectisamemberofthePivotAggregatescollection.

UsingthePivotAggregateObjectThePivotAggregatescollection’sItempropertyreturnsaPivotAggregateobject.

PivotAxisObject

Multipleobjects PivotAxisMultipleobjects

UsedasthebaseclassforthePivotResultAxis,PivotResultColumnAxis,PivotResultDataAxis,PivotResultFilterAxis,PivotResultGroupAxis,PivotResultPageAxis,andPivotResultRowAxisobjects.UsetheSourceAxispropertyofoneoftheseobjectstoreturnaPivotAxisobject.

PivotAxisMemberObject

Multipleobjects PivotAxisMemberMultipleobjects

Representsthevaluesdisplayedforagroupedfield.ThePivotAxisMemberobjectisamemberofthePivotAxisMemberscollection.

UsingthePivotAxisMemberobjectThefollowingpropertiesreturnaPivotAxisMemberobject:

TheFindAxisMemberpropertyofthePivotAxisMember,PivotColumnMember,PivotPageMember,andPivotRowMemberobjects

TheParentAxisMemberpropertyofthePivotAxisMember,PivotColumnMember,PivotPageMember,andPivotRowMemberobjects

TheTotalMemberpropertyofthePivotAxisMember,PivotColumnMember,PivotPageMember,andPivotRowMemberobjects

TheMemberpropertyofthePivotResultColumnAxis,PivotResultGroupAxis,PivotResultPageAxis,andPivotResultRowAxisobjects

TheItempropertyofthePivotAxisMemberscollection.

ThePivotAxisMemberhasmanypropertiesincommonwiththePivotMemberobject.HoweverthePivotAxisMemberobjectcontainssomepropertiesthatthePivotMemberobjectdoesnothave.YoucanusetheGroupFieldandCustomGroupTypepropertiestoaccessthegroupingsettingsofthemember.YoucanusetheHyperlinkpropertytoaccessthehyperlinksettingsofthemember.TheMemberPropertiespropertycanbeusedtoaccessanymemberpropertiesofthemember.TheHeight,Left,andWidthpropertiescanbeusedtosetthesizeandpositionofthemember.

PivotCellObject

Multipleobjects PivotCellMultipleobjects

Representsacell(agroupingofdata)inaPivotTablelist.Acelldisplaysaggregates,andiftheunderlyingdetailrecordsareavailable,youcanhavethecelldisplayadetailgrid.Groupedfieldsontherowandcolumnaxisdeterminetheamountofdatathatagivencellrepresents.Evenasimplelistwithnogroupedfieldsisreallyasinglecelldisplayingadetailgrid.

UsingthePivotCellObjectThefollowingpropertiesreturnaPivotCellobject:

ThePivotAggregate,PivotDetailCell,andPivotDetailRangeobjects'Cellproperty

ThePivotDataobject’sCells,CellsEx,andCurrentCellproperties

ThePivotRangeobject’sBottomRight,Cells,andTopLeftproperties

PivotColumnMemberObject

Multipleobjects PivotColumnMemberMultipleobjects

RepresentsthevaluesdisplayedforagroupedfieldinthecolumnareaofaPivotTablelist.ThePivotColumnMemberobjectisamemberofthePivotColumnMemberscollection.

UsingthePivotColumnMemberobjectThefollowingpropertiesreturnaPivotColumnMemberobject:

ThePivotCellobject'sColumnMemberproperty

ThePivotResultColumnAxisobject'sColumnMemberproperty

ThePivotColumnMemberobject'sFindColumnMemberproperty

ThePivotColumnMemberobject'sParentColumnMemberproperty

ThePivotColumnMemberobject'sTotalColumnMemberproperty

ThePivotColumnMemberscollection'sItemproperty

ThePivotDataobject'sLeftproperty

ThePivotColumnMemberobjecthasmanypropertiesincommonwiththePivotAxisMemberobject.UsetheDetailLeft,DetailLeftOffset,DetailsExpandedpropertiesorMoveDetailLeftmethodtocustomizethewaydetailrecordsaredisplayed.

PivotDataObject

Multipleobjects PivotDataMultipleobjects

RepresentsthedatainaPivotTablelist.

UsingthePivotDataObjectThefollowingpropertiesreturnaPivotDataobject:

TheDatapropertyofthefollowingobjects:PivotCell,PivotResultAxis,PivotResultColumnAxis,PivotResultDataAxis,PivotResultFilterAxis,PivotResultGroupAxis,PivotResultPageAxis,andPivotResultRowAxis.

ThePivotTableobject’sActiveDataproperty.

PivotDataAxisObject

Multipleobjects PivotDataAxisMultipleobjects

RepresentsthedataaxisforaPivotTablelist.Thedataaxiscontainsfieldsetsandtotals.

UsingthePivotDataAxisObjectThefollowingpropertiesreturnaPivotDataAxisobject:

ThePivotViewobject’sDataAxisproperty

ThePivotResultDataAxisobject'sSourceDataAxisproperty

PivotDetailCellObject

Multipleobjects PivotDetailCellMultipleobjects

RepresentsacellinthedetailgridforaPivotTablelist.

UsingthePivotDetailCellObjectThefollowingpropertiesreturnaPivotDetailCellobject:

ThePivotCellobject’sDetailCellsproperty

ThePivotDetailRangeobject’sBottomRightproperty

ThePivotDetailRangeobject’sTopLeftproperty

PivotDetailRangeObject

PivotCell PivotDetailRangeMultipleobjects

RepresentstherangeofcellsinthedetailgridforaPivotTablelist.

UsingthePivotDetailRangeObjectThePivotCellobject’sDetailRangepropertyreturnsaPivotDetailRangeobject.

PivotFieldObject

Multipleobjects PivotFieldMultipleobjects

RepresentsasinglefieldinaPivotTablelist.

UsingthePivotFieldObjectThefollowingpropertiesandmethodsreturnaPivotFieldobject:

TheFieldpropertyofthefollowingobjects:PivotAxisMember,PivotColumnMember,PivotDetailCell,PivotMember,PivotPageMember,PivotRowMember,andPivotTotal.

ThePivotFieldobject'sFilterContextproperty.

ThePivotFieldsobject’sItemproperty.

ThePivotFieldSetobject’sAddCalculatedFieldandAddCustomGroupFieldmethods,andBoundFieldproperty.

ThePivotResultFieldandPivotResultGroupFieldobjects'SourceFieldproperty.

PivotFieldSetObject

Multipleobjects PivotFieldSetMultipleobjects

Representsasetoffieldsthathavebeenlockedtogethertoformahierarchy.Forexample,inafieldsetforgeography,thefieldsmightbeContinent,Country/Region,State,andCity—inthatorder.Typically,afieldsetwillonlycontainasinglefieldifthedatasourceisarecordset.

UsingthePivotFieldSetObjectThefollowingpropertiesandmethodreturnaPivotFieldSetobject:

ThePivotFieldobject’sFieldSetproperty.

ThePivotFieldSetsobject’sItemproperty.

ThePivotViewobject'sAddFieldSetmethod.

PivotFilterAxisObject

Multipleobjects PivotFilterAxisMultipleobjects

RepresentsthefilteraxisinaPivotTablelist.

UsingthePivotFilterAxisObjectThefollowingpropertiesreturnaPivotFilterAxisobject:

ThePivotViewobject’sFilterAxisproperty

ThePivotResultFilterAxisobject'sSourceFilterAxisproperty

PivotFontObject

Multipleobjects PivotFont

Containsthefontattributes(fontname,fontsize,color,andsoon)forthespecifiedobject.

UsingthePivotFontObjectThefollowingpropertiesreturnaPivotFontobject:

ThePivotFieldobject’sDetailFont,GroupedFont,andSubtotalFontproperties

ThePivotLabelobject’sFontproperty

ThePivotViewobject’sFieldLabelFont,HeaderFont,PropertyCaptionFont,PropertyValueFont,andTotalFontproperties

PivotGroupAxisObject

Multipleobjects PivotGroupAxisMultipleobjects

RepresentsthegroupaxisinaPivotTablelist.

UsingthePivotGroupAxisObjectThefollowingpropertiesreturnaPivotGroupAxisobject:

ThePivotResultColumnAxisobject'sSourceColumnAxisproperty

ThePivotResultPageAxisobject'sSourcePageAxisproperty

ThePivotResultRowAxisobject'sSourceRowAxisproperty

ThePivotViewobject’sColumnAxis,PageAxis,andRowAxisproperties

PivotHyperlinkObject

Multipleobjects PivotHyperlink

RepresentsahyperlinkinaPivotTablelist.

UsingthePivotHyperlinkobjectUsetheHyperlinkpropertyofthePivotDetailCell,PivotAxisMember,PivotColumnMember,PivotRowMemberorPivotPageMemberobjectstoreturnaPivotHyperlinkobject.

ThePivotTablecontrolwilltreatfieldmembersashyperlinkswhentheIsHyperlinkpropertyofthefieldissettoTrue.

UsetheAddresspropertytoreturntheaddressforaPivotHyperlinkobject.TheAddresspropertyofaPivotHyperlinkobjectisread-only.YoumustupdatethedatabaseitselftochangetheaddressofahyperlinkinaPivotTablelist.UsetheFollowmethodtoresolve,download,anddisplaythetargetdocument.

PivotLabelObject

Multipleobjects PivotLabelPivotFont

Representsthelabelforthespecifiedobject.Containsformatattributes(foregroundcolor,backgroundcolor,font,andsoon).

UsingthePivotLabelObjectThefollowingpropertiesreturnaPivotLabelobject:

ThePivotAxisobject’sLabelproperty

ThePivotDataAxisobject’sLabelproperty

ThePivotFilterAxisobject’sLabelproperty

ThePivotGroupAxisobject’sLabelproperty

ThePivotResultLabelobject'sSourceLabelproperty

ThePivotViewobject’sLabelproperty

ThePivotViewobject’sTitleBarproperty

PivotMemberObject

Multipleobjects PivotMemberMultipleobjects

Representsthevaluesdisplayedforagroupedfield.

UsingthePivotMemberObjectThefollowingpropertiesandmethodreturnaPivotMemberobject:

TheFindMemberpropertyofthefollowingobjects:PivotAxisMember,PivotColumnMember,PivotFieldSet,PivotPageMember,orPivotRowMember

TheParentMemberpropertyofthefollowingobjects:PivotAxisMember,PivotColumnMember,PivotMember,PivotPageMember,orPivotRowMember

TheSourceMemberpropertyofthefollowingobjects:PivotAxisMember,PivotColumnMember,PivotPageMember,orPivotRowMember

ThePivotFieldobject'sAddCustomGroupMembermethod

ThePivotFieldSetobject'sAllMemberorMemberproperties

ThePivotMembersobject’sItemproperty

PivotMemberPropertyObject

Multipleobjects PivotMemberProperty

RepresentsamemberpropertyforaPivotTablemember.AmemberpropertyisacustompropertythathasbeendefinedforthememberinanOLAPcube.

UsingthePivotMemberPropertyobjectThefollowingpropertiesreturnaPivotMemberPropertyobject:

ThePivotMemberPropertiescollection'sItemproperty

ThePivotResultMemberPropertyobject'sMemberPropertyproperty

UsetheDisplayInpropertytocontrolwhetherthespecifiedmemberpropertyisdisplayedinthePivotTablelist,ScreenTip,boththePivotTablelistandScreenTip,ornotatall.UsetheCaptionpropertytosetthecaptionforamemberproperty.

Thefollowingexamplesetsthecaptionsof,andthendisplaysthemembercaptionsoftheStoreNamefield.

SubDisplayMemberProperties()

DimptViewDimptConstantsDimfldStoreName

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetptView=PivotTable1.ActiveView

'SetavariabletotheStoreNamefield.SetfldStoreName=ptView.FieldSets("Store").Fields("StoreName")

'Thefollowingthreelinesofcodespecifythatthememberpropertiesare'displayedinthePivotTablelist.fldStoreName.MemberProperties("StoreManager").DisplayIn=ptConstants.plDisplayPropertyInReportfldStoreName.MemberProperties("StoreType").DisplayIn=ptConstants.plDisplayPropertyInReportfldStoreName.MemberProperties("StoreSqft").DisplayIn=ptConstants.plDisplayPropertyInReport

'Thefollowingthreelinesofcodesetthecaptionforthememberproperties.fldStoreName.MemberProperties("StoreManager").Caption="ManagerName"fldStoreName.MemberProperties("StoreType").Caption="StoreType"fldStoreName.MemberProperties("StoreSqft").Caption="SizeinSQFT"

EndSub

PivotPageMemberObject

Multipleobjects PivotPageMemberMultipleobjects

RepresentsthevaluesdisplayedforagroupedfieldinthepageareaofaPivotTablelist.ThePivotPageMemberobjectisamemberofthePivotPageMemberscollection.

UsingthePivotPageMemberobjectThefollowingpropertiesreturnaPivotRowMemberobject:

ThePivotCellobject'sPageMemberproperty

ThePivotResultPageAxisobject'sPageMemberproperty

ThePivotPageMemberobject'sFindPageMemberproperty

ThePivotPageMemberobject'sParentPageMemberproperty

ThePivotPageMemberobject'sTotalPageMemberproperty

ThePivotPageMembercollection'sItemproperty

ThePivotPageMemberobjecthasmanypropertiesincommonwiththePivotAxisMemberobject.

PivotRangeObject

PivotData PivotRangeMultipleobjects

RepresentsarangeofcellsinaPivotTablelist.

UsingthePivotRangeObjectThePivotDataobject’sRangepropertyreturnsaPivotRangeobject.

PivotResultAxisObject

Multipleobjects PivotResultAxisMultipleobjects

ContainspointerstothedataforaresultaxisinaPivotTablelist.

UsingthePivotResultAxisobjectThefollowingpropertiesreturnaPivotResultAxisobject:

ThePivotResultFieldobject'sAxisproperty.

ThePivotResultGroupFieldobject'sAxisproperty.

UsetheDatapropertytorefertothedata.UsetheSourceAxispropertytorefertothesourceaxis.

PivotResultColumnAxisObject

PivotData PivotResultColumnAxisMultipleobjects

RepresentsthedataincolumnaxisofaPivotTablelist.

UsingthePivotResultColumnAxisobjectTheColumnAxispropertyofthePivotDataobjectreturnsaPivotResultColumnAxisobject.

UsetheDatapropertytoreturnapointertothedata.

UsetheSourceColumnAxispropertytoreturnapointertotheaxis.

PivotResultDataAxisObject

PivotData PivotResultDataAxisMultipleobjects

RepresentsthedataaxisofaPivotTablelist.

UsingthePivotResultDataAxisobjectTheDataAxispropertyofthePivotDataobjectreturnsaPivotResultDataAxisobject.

UsetheDatapropertytoreturnapointertothedata.

UsetheSourceDataAxispropertytoreturnapointertotheaxis.

PivotResultFieldObject

PivotResultField Multipleobjects

Pointstothesourcefieldandaxisofaresultfield.

UsingthePivotResultFieldobjectUsetheSourceAxispropertyoftheobjectreturnedbytheAxispropertytorefertothesourceaxisfortheresultfield.

UsetheSourceFieldpropertytorefertothesourcefieldfortheresultfield.

PivotResultFilterAxisObject

PivotData PivotResultFilterAxisMultipleobjects

RepresentsthedataofthefilteraxisofaPivotTablelist.

UsingthePivotResultFilterAxisobjectTheFilterAxispropertyofthePivotDataobjectreturnsaPivotResultFilterAxisobject.

UsetheDatapropertytoreturnapointertothedata.

UsetheSourceFilterAxispropertytoreturnapointertotheaxis.

PivotResultGroupAxisObject

Multipleobjects PivotResultGroupAxisMultipleobjects

RepresentsthedatainthegroupingaxisofaPivotTablelist.

UsingthePivotResultGroupAxisobjectThefollowingpropertiesreturnaPivotResultGroupAxisobject:

TheChCategoryLabelsobject'sPivotAxisproperty

TheChSeriesCollectionobject'sPivotAxisproperty

ThePivotAxisMemberobject'sAxisproperty

ThePivotColumnMemberobject'sAxisproperty

ThePivotRowMemberobject'sAxisproperty

ThePivotPageMemberobject'sAxisproperty

UsetheDatapropertytoreturnapointertothedata.

UsetheSourceAxispropertytoreturnapointertotheaxis.

PivotResultGroupFieldObject

Multipleobjects PivotResultGroupFieldMultipleobjects

Representsthegroupingfieldforaresultmember.

UsingthePivotResultGroupFieldobjectThefollowingpropertiesreturnaPivotResultGroupFieldobject:

ThePivotResultGroupFieldscollection'sItemproperty.

ThePivotAxisMemberobject'sGroupFieldproperty.

ThePivotColumnMemberobject'sGroupFieldproperty.

ThePivotPageMemberobject'sGroupFieldproperty.

ThePivotRowMemberobject'sGroupFieldproperty.

UsethePivotResultAxisobjectreturnedbythetheAxispropertytoconfigurethesourceaxis.

UsethePivotFieldobjectreturnedbytheSourceFieldpropertytoconfigurethesourcefield.

PivotResultLabelObject

Multipleobjects PivotResultLabelPivotLabel

Representsthelabelforaresultaxis.

UsingthePivotResultLabelobjectThefollowingpropertiesreturnaPivotResultLabelobject:

ThePivotDataobject'sLabelproperty

ThePivotResultAxisobject'sLabelproperty

ThePivotResultColumnAxisobject'sLabelproperty

ThePivotResultDataAxisobject'sLabelproperty

ThePivotResultFilterAxisobject'sLabelproperty

ThePivotResultGroupAxisobject'sLabelproperty

ThePivotResultPageAxisobject'sLabelproperty

ThePivotResultRowAxisobject'sLabelproperty

UsethePivotLabelobjectreturnedbytheSourceLabelpropertytoformattheresultlabel.

PivotResultMemberPropertyObject

Multipleobjects PivotResultMemberPropertiesPivotResultMemberPropertyPivotMemberProperty

Representsamemberpropertyforaresultmember.

UsingthePivotResultMemberPropertyobjectTheItempropertyofthePivotResultMemberPropertiescollectionreturnsaPivotResultMemberPropertyobject.

UsethePivotMemberPropertyobjectreturnedbytheMemberPropertypropertytoaccessthesettingsforthememberproperty.

PivotResultPageAxisObject

PivotData PivotResultPageAxisMultipleobjects

RepresentsthedatatheofrowaxisofaPivotTablelist.

UsingthePivotResultPageAxisobjectThePageAxispropertyofthePivotDataobjectreturnsaPivotResultPageAxisobject.

UsetheDatapropertytoreturnapointertothedata.

UsetheSourcePageAxispropertytoreturnapointertotheaxis.

PivotResultRowAxisObject

PivotData PivotResultRowAxisMultipleobjects

RepresentsthedatatheofrowaxisofaPivotTablelist.

UsingthePivotResultRowAxisobjectTheRowAxispropertyofthePivotDataobjectreturnsaPivotResultRowAxisobject.

UsetheDatapropertytoreturnapointertothedata.

UsetheSourceRowAxispropertytoreturnapointertotheaxis.

PivotRowMemberObject

Multipleobjects PivotRowMemberMultipleobjects

RepresentsthevaluesdisplayedforagroupedfieldintherowareaofaPivotTablelist.ThePivotRowMemberobjectisamemberofthePivotRowMemberscollection.

UsingthePivotRowMemberobjectThefollowingpropertiesreturnaPivotRowMemberobject:

ThePivotCellobject'sRowMemberproperty.

ThePivotResultRowAxisobject'sRowMemberproperty.

ThePivotRowMemberobject'sFindRowMemberproperty.

ThePivotRowMemberobject'sParentRowMemberproperty.

ThePivotRowMemberobject'sTotalRowMemberproperty.

ThePivotRowMembercollection'sItemproperty.

ThePivotDataobject'sTopproperty.

ThePivotRowMemberobjecthasmanypropertiesincommonwiththePivotAxisMemberobject.UsetheTotalRowHeightandTotalRowMemberpropertiestocustomizethewaytotalsaredisplayed.

PivotTableObject

PivotTable Multipleobjects

RepresentsthecontainerforaPivotTablelist.

UsingthePivotTableObjectYoucanuseeithertheCreateObjectmethodortheNewkeywordtocreateaPivotTableobject.

TheobjectIDforaPivotTablelistonanHTMLpagereturnsaPivotTableobject.TheprogrammaticidentifierforthePivotTableobjectisCLSID:0002E55A-0000-0000-C000-000000000046.ThefollowingexamplecreatesaPivotTablelistnamed"PivotTable1"onanHTMLpage.

<objectid=PivotTable1classid=CLSID:0002E55A-0000-0000-C000-000000000046></object>

PivotTotalObject

Multipleobjects PivotTotalMultipleobjects

RepresentsatotalinaPivotTablelist.Atotalistheaggregatevaluethatisdisplayedforthecontentsofagivencell.

UsingthePivotTotalObjectThefollowingpropertiesandmethodsreturnaPivotTotalobject:

ThePivotAggregateobject'sTotalproperty

ThePivotFieldobject'sFilterOnandSortOnproperties

ThePivotTotalsobject'sItemproperty

ThePivotViewobject'sAddCalculatedTotalandAddTotalmethods

PivotViewObject

Multipleobjects PivotViewMultipleobjects

RepresentsaspecificviewofaPivotTablelist.

UsingthePivotViewObjectTheViewpropertyofthefollowingobjectsreturnsaPivotViewobject:PivotAxis,PivotAxisMember,PivotColumnMember,PivotData,PivotDataAxis,PivotFieldSet,PivotFilterAxis,PivotGroupAxis,PivotMember,PivotPageMember,PivotRowMember,andPivotTotal.

ThePivotTableobject’sActiveViewpropertyalsoreturnsaPivotViewobject.

ProtectionObject

Worksheet ProtectionWorksheet

Containstheprotectionpropertiesforaworksheet.

UsingtheProtectionObjectTheWorksheetobject’sProtectionpropertyreturnsaProtectionobject.

RangeObject

Multipleobjects RangeMultipleobjects

Representsacell,arangeofcells,arow,oracolumn.

UsingtheRangeObjectThefollowingpropertiesandmethodsreturnaRangeobject.

Object Properties/MethodsAutoFilter RangeListObject DataBodyRange

HeaderRowRangeInsertRowRangeRange

ListRow RangeName RefersToRangePane VisibleRangeRange Cells

ColumnsCurrentArrayCurrentRegionEndEntireColumnEntireRowFindFindNextFindPreviousItemMergeAreaNextOffsetPreviousRangeRows

Spreadsheet ActiveCell

CellsColumnsRangeRectIntersectRectUnionRowsSelection

Window ActiveCellRangeFromPointRangeSelectionSelectionVisibleRange

Worksheet CellsColumnsRangeRowsUsedRange

RecordNavigationControlObject

RecordNavigationControl

Representsarecordnavigationcontrol.

UsingtheRecordNavigationControlObjectYoucanuseeithertheCreateObjectmethodortheNewkeywordtocreateaRecordNavigationControlobject.

TheobjectIDforarecordnavigationcontrolonanHTMLpagereturnsaRecordNavigationControlobject.TheprogrammaticidentifierfortheRecordNavigationControlobjectisCLSID:0002E55C-0000-0000-C000-000000000046.Thefollowingexamplecreatesarecordnavigationcontrolnamed"RNC1"onanHTMLpage.

<objectid=RNC1classid=CLSID:0002E55C-0000-0000-C000-000000000046></object>

RecordsetDefObject

Multipleobjects RecordsetDefMultipleobjects

Representsarecordsetdefinition.

UsingtheRecordsetDefObjectThefollowingpropertiesreturnaRecordsetDefobject:

ThePageFieldobject'sRecordsetDefproperty

ThePageRowsourceobject'sRecordsetDefproperty

TheRecordsetDefobject'sParentRecordsetDefproperty

TheRecordsetDefsobject'sItemproperty,anditsAddandAddNewmethods

SchemaFieldObject

SchemaRowsource SchemaFieldsSchemaFieldSchemaProperties

Representsafieldinaschemarowsource.ThenamesofthesefieldsareusedingeneratingSELECTstatementsforrowsourcesoftypedscTableordscView.TheSchemaFieldobjectisamemberoftheSchemaFieldscollection.

UsingtheSchemaFieldObjectThefollowingmethodandpropertyreturnaSchemaFieldobject:

TheSchemaFieldscollection'sAddmethod

TheSchemaFieldscollection'sItemproperty

SchemaParameterObject

SchemaRowsource SchemaParametersSchemaParameterSchemaProperties

Representsasingleparameterforaschemarowsource.TheSchemaParameterobjectisamemberoftheSchemaParameterscollection.

UsingtheSchemaParameterObjectThefollowingmethodandpropertyreturnaSchemaParameterobject:

TheSchemaParameterscollection'sAddmethod

TheSchemaParameterscollection'sItemproperty

SchemaPropertiesObject

Multipleobjects SchemaPropertiesSchemaProperty

Thisobjectisnotdocumented.

SchemaPropertyObject

Multipleobjects SchemaPropertiesSchemaProperty

Thisobjectisnotdocumented.

SchemaRelatedFieldObject

SchemaRelationship SchemaRelatedFieldsSchemaRelatedField

Describesthecolumnpairingsthatmakeupaschemarelationship.ThenamesofthesefieldsareusedingeneratingjoinclausesinSQLandfortyingaparentrecordsetdefinitiontoasublistchildrecordsetdefinition.TheSchemaRelatedFieldobjectisamemberoftheSchemaRelatedFieldscollection.

UsingtheSchemaRelatedFieldThefollowingmethodandpropertyreturnaSchemaRelatedFieldobject:

TheSchemaRelatedFieldscollection'sAddmethod

TheSchemaRelatedFieldscollection'sItemproperty

SchemaRelatedFieldsCollectionObject

SchemaRelationship SchemaRelatedFieldsSchemaRelatedField

ThecollectionofSchemaRelatedFieldobjectsforaschemarelationship.

UsingtheSchemaRelatedFieldsCollectionTheSchemaRelationshipobject'sSchemaRelatedFieldspropertyreturnsaSchemaRelatedFieldscollection.

SchemaRelationshipObject

Multipleobjects SchemaRelationshipSchemaRelatedFields

Representsaschemarelationship.Aschemarelationshipdescribeshowschemarowsourcesareconnected,anditalwayshasa“one”sideanda“many”side(fromaone-to-manyrelationship).TheSchemaRelationshipobjectisamemberoftheSchemaRelationshipscollection.

UsingtheSchemaRelationshipObjectThefollowingpropertiesandmethodreturnaSchemaRelationshipobject:

TheLookupSchemaRelationshipscollection'sItemproperty

TheSchemaRelationshipscollection'sAddandAddNewmethods,andItemproperty

TheSublistSchemaRelationshipscollection'sItemproperty

SchemaRowsourceObject

Multipleobjects SchemaRowsourcesSchemaRowsourceMultipleobjects

Representsaschemarowsource.Everytable,view,orstoredprocedureinthedatabaseisapotentialschemarowsource,asarecommandsdefinedexplicitlytothedatasourcecontrol.

TheSchemaRowsourceobjectisamemberoftheSchemaRowsourcescollection.

UsingtheSchemaRowsourceObjectThefollowingmethodandpropertyreturnaSchemaRowsourceobject:

TheSchemaRowsourcescollection'sAddandAddNewmethods

TheSchemaRowsourcescollection'sItemproperty.

SectionObject

Multipleobjects SectionMultipleobjects

Aninstanceofasinglegroupheader,footer,caption,ornavigationsection.

UsingtheSectionObjectThefollowingpropertiesandmethodreturnaSectionobject:

Object Properties/MethodDataPage FirstSectionDataSourceControl CurrentSection

GetContainingSectionDSCEventInfo SectionSection ChildSection

NextSectionNextSiblingParentSectionPreviousSectionPreviousSibling

SpreadsheetObject

Spreadsheet Multipleobjects

Representsthecontainerforthespreadsheet.

UsingtheSpreadsheetObjectYoucanusetheCreateObjectmethodortheNewkeywordtocreateaSpreadsheetobject.

TheobjectIDforaspreadsheetcontrolonanHTMLpageoraVisualBasicformreturnsaSpreadsheetobject.

TheprogrammaticidentifierfortheSpreadsheetobjectisCLSID:0002E559-0000-0000-C000-000000000046.Thefollowingexamplecreatesaspreadsheetnamed"Spreadsheet1"onanHTMLpage.

<objectid=Spreadsheet1classid=CLSID:0002E559-0000-0000-C000-000000000046style="width:49%;height:350"></object>

TitleBarObject

Multipleobjects TitleBarMultipleobjects

Representsthetitlebaronthespreadsheet.

UsingtheTitleBarObjectTheSpreadsheetobject’sTitleBarpropertyreturnsaTitleBarobject.

WindowObject

Multipleobjects WindowMultipleobjects

Representsawindow.Manyworksheetcharacteristics,suchasscrollbarsandgridlines,areactuallypropertiesofthewindow.TheWindowobjectisamemberoftheWindowscollection.EachworksheethasauniqueWindowobject.Codecanonlyaccessthewindowfortheactivesheetoftheworkbook.Inotherwords,althoughtheWindowscollectionstatesthatthereisonlyoneWindowobject,thereare,infact,multipleWindowobjects,butyoumayonlyaccesstheWindowobjectfortheactivesheet.

UsingtheWindowobjectThefollowingpropertiesreturnaWindowobject.

TheSpreadsheetobject'sActiveWindowproperty.

TheWindowscollection'sItemproperty.

ThefollowingexamplehidestherowandcolumnheadingsintheactivewindowofSpreadsheet1.

SubHideHeadings()

Spreadsheet1.ActiveWindow.DisplayColumnHeadings=FalseSpreadsheet1.ActiveWindow.DisplayRowHeadings=False

EndSub

ThefollowingexamplemovescolumnCsothatit'stheleftmostcolumninthewindow.

Spreadsheet1.ActiveWindow.ScrollColumn=3

WorkbookObject

Multipleobjects WorkbookMultipleobjects

Representsaworkbook.TheWorkbookobjectisamemberoftheWorkbookscollection.

UsingtheWorkbookobjectUsetheActiveWorkbookpropertyoftheSpreadsheetobjecttoreturnareferencetotheopenworkbook.

AworkbookcontainsaWorksheetscollection.

WorksheetObject

Multipleobjects WorksheetMultipleobjects

Representsasingleworksheetinaworkbook.

UsingtheWorksheetObjectThefollowingpropertiesreturnaWorksheetobject:

TheRangeobject’sWorksheetproperty

TheSpreadsheet,Window,andWorkbookobjects'ActiveSheetproperty

TheWorksheetobject'sNextandPreviousproperties

TheWorksheetscollection'sAddmethodandItemproperty

XmlDataBindingObject

XmlDataBindings XmlDataBindingMultipleobjects

AnXmlDataBindingobjectrepresentsanXMLdatabindinginaSpreadsheetcomponent.Youcanbind,orconnect,aSpreadsheetcomponenttoadataretrievalservice,SOAPWebService,XMLfile,orWebPart,andthatbindingisrepresentedbytheXmlDataBindingobject.

UsingtheXmlDataBindingObjectTheXMLDataBindingobjectisamemberoftheXmlDataBindingscollection,whichisacollectionofalloftheXmlDataBindingobjectsinaSpreadsheetcomponent.Withinthecollection,individualXmlDataBindingobjectsareindexedbeginningwith1forthefirstobject,2forthesecond,andsoon.YoucanreturnaXmlDataBindingobjectfromtheXmlDataBindingscollectionbyusingtheItempropertyofthecollection.TheargumentfortheItempropertyistheindexinthecollectionoftheobjectyouwanttoreturnorthebindingIDoftheobject.ThebindingIDisthevalueoftheIDattributeintheXMLthatrepresentsthebinding.YoucanfindthisintheXMLSpreadsheetfilefortheSpreadsheetcomponent(orSpreadsheetWebPart)orbyexaminingtheBindingDatapropertyoftheXmlDataBindingobject.YoucancreateanXMLSpreadsheetfilebycreatingadataboundspreadsheetusingMicrosoftExcelandthensavingtheworkbookasanXMLSpreadsheet.

YoucreateanewXmlDataBindingobjectusingtheAddmethodoftheXmlDataBindingscollection.OnceyouhavecreatedtheXmlDataBindingobject,youcanuseitsBindingDatapropertytospecifybindingconfigurationinformation.

ThefollowingexampleshowshowtoworkwitheachXmlDataBindingobjectrelatedtoaSpreadsheetcomponent:

DimobjBindingsDimobjBindingDimstrBindingInfo

SetobjBindings=Spreadsheet1.ActiveWorkbook.XmlDataBindings

ForEachobjBindinginobjBindings'SavetheXMLbindinginformationtoavariable.strBindingInfo=objBinding.BindingData'Workwiththebindinginformationhere.Next

XmlMapObject

Workbook XmlMapsXmlMapWorkbook

AnXmlMapobjectrepresentstheXMLschemamapforaSpreadsheetcomponent.TheXmlMapobjectisamemberoftheXmlMapscollection.

UsingtheXmlMapObjectIntheXmlMapscollection,individualXmlMapobjectsareindexedbeginningwith1forthefirstobject,2forthesecondobject,andsoon.YoureturnaXmlMapobjectfromtheXmlMapscollectionusingtheItemproperty.TheargumentfortheItempropertyistheindexinthecollectionoftheobjectyouwanttoreturnorthemapIDoftheobject.ThemapIDisthevalueoftheIDattributeintheXMLthatrepresentsthemap.YoucanfindthisintheXMLSpreadsheetfileforthepartorbyexaminingtheMapDatapropertyoftheXmlMapobject.YoucancreateanXMLSpreadsheetfilebycreatingadata-boundspreadsheetinMicrosoftExcelandthensavingtheworkbookasanXMLSpreadsheet.YoucancreateanewXmlMapobjectbyusingtheAddmethodoftheXmlMapscollection.

ThefollowingexampleshowshowtoworkwitheachXmlMapobjectrelatedtoaSpreadsheetcomponent.ItusestheXmlMapspropertyoftheActiveWorkbookobjecttoreturntheXmlMapscollectionobject:

DimobjMapsDimobjMapDimstrMapInfo

SetobjMaps=Spreadsheet1.ActiveWorkbook.XmlMaps

ForEachobjMapinobjMaps'SavetheXMLmapinformationtoavariable.strMapInfo=objMap.MapData'WorkwiththemapinformationXMLhere.Next

ShowAll

ActivateMethod

ActivatemethodasitappliestotheRangeobject.

ActivatemethodasitappliestotheWorksheetobject.

ExampleAsitappliestotheRangeobject.

AsitappliestotheWorksheetobject.

ShowAll

AddMethod

AddmethodasitappliestotheChAxesobject.

AddmethodasitappliestotheChChartsobject.

AddmethodasitappliestotheChDataLabelsCollectionobject.

AddmethodasitappliestotheChErrorBarsCollectionobject.

AddmethodasitappliestotheChSegmentsobject.

AddmethodasitappliestotheChSeriesCollectionobject.

AddmethodasitappliestotheChTrendlinesobject.

AddmethodasitappliestotheElementExtensionsobject.

AddmethodasitappliestotheGroupingDefsobject.

AddmethodasitappliestotheGroupLevelsobject.

AddmethodasitappliestotheSheetsandWorksheetsobjects.

AddmethodasitappliestothePageFieldsobject.

AddmethodasitappliestotheLookupRelationshipsandSublistRelationshipsobjects.

AddmethodasitappliestotheParameterValuesobject.

AddmethodasitappliestotheRecordsetDefsobject.

AddmethodasitappliestotheSchemaFieldsobject.

AddmethodasitappliestotheSchemaParametersobject.

AddmethodasitappliestotheSchemaRelatedFieldsobject.

AddmethodasitappliestotheSchemaRelationshipsobject.

AddmethodasitappliestotheSchemaRowsourcesobject.

AddmethodasitappliestotheCriteriaobject.

AddmethodasitappliestotheNamesobject.

AddmethodasitappliestotheListRowscollection.

AddmethodasitappliestotheXmlDataBindingscollection.

AddmethodasitappliestotheXmlMapscollection.

ExampleAsitappliestotheChChartsobject.

AsitappliestotheChDataLabelsCollectionobject.

AsitappliestotheChErrorBarsCollectionobject.

AsitappliestotheChSeriesCollectionobject.

AsitappliestotheChTrendlinesobject.

AsitappliestotheCriteriaobject.

AddCalculatedFieldMethod

AddsacalculatedfieldtoaPivotTable.Acalculatedfieldcanbeusedlikeanyotherfieldforsorting,filtering,orgrouping.YoumustusetheAddFieldSetmethodtocreateacustomfieldsetbeforeyouaddacalculatedfield.ReturnsaPivotFieldobject.

expression.AddCalculatedField(Name,Caption,DataField,Expression)

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobjectthatwascreatedbytheAddFieldSetmethod.

NameRequiredString.Thenameofthecalculatedfield.Thenamemustbeuniquewithinthefieldset.

CaptionRequiredString.ThecaptiondisplayedforthecalculatedfieldinthePivotTableuserinterface.Althoughthisargumentisrequired,youcanassignablankstringtothecaption.

DataFieldRequiredString.ThenameofthenewfieldthatiscreatedintheunderlyingrecordsetforthePivotTable.

ExpressionRequiredString.Theexpressionusedtocalculatetheitemsinthenewfield.TheexpressionmustbecompatiblewiththeJetexpressionservice.

RemarksCustomfieldsetscancontainonlyonecalculatedfield.Addingasecondcalculatedfieldtoacustomfieldsetresultsinarun-timeerror.

ExampleThisexampleaddsanewfieldsetnamed"Variance"toPivotTable1.Withinthenewfieldset,acalculatedfieldwiththecaption"BudgetVariance"iscreated.ThecalculatedfieldistheninsertedintothePivotTableview.

SubTestAddFieldSet()

DimvwViewDimfsNewFieldSet

SetvwView=PivotTable1.ActiveView

'AddacustomfieldsettothePivotTable.SetfsNewFieldSet=vwView.AddFieldSet("Variance")

'Addacalculatedtotaltothenewlycreatedfieldset.fsNewFieldSet.AddCalculatedField"Variance",_

"BudgetVariance","fldVariance",_

"Budget/Actual"

'Insertthecalculatedfieldintothedataaxis.vwView.DataAxis.InsertFieldSetfsNewFieldSet

EndSub

AddCalculatedTotalMethod

AddsacalculatedtotaltoaPivotTable.UsetheAddCalculatedTotalmethodtocreateacustomtotalbasedontotalsalreadydefinedinthePivotTable.ThecalculatedtotalisreturnedasaPivotTotalobject.

expression.AddCalculatedTotal(Name,Caption,Expression,SolveOrder)

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

NameRequiredString.UsedtoidentifythenewcalculatedtotalinthePivotTotalscollection.ThisparametermustbeuniquewithinthePivotTotalscollection.Mustbebetween1and50charactersinlength.

CaptionRequiredString.UsedtoidentifythenewcalculatedtotalinthePivotTableuserinterface.

ExpressionRequiredString.Theexpressionusedtocalculatethenewcalculatedtotal.Mustbeavalidmultidimensionalexpression(MDX)statementfortheOLEDBproviderthatisbeingusedtoaccessthedata.

SolveOrderOptionalLong.IndicatesthesolveorderofthenewcalculatedtotalwhenthePivotTableisrefreshed.TheSolveOrderparameterisusefulifyoucreateacalculatedtotalthatisdependentoncalculatedtotalsthatwerecreatedearlier.

ExampleThefollowingexampleaddsacalculatedtotalnamed"SalesinLastPeriod"toaPivotTablenamed"PivotTable1."Thenewcalculatedtotaldisplaysthesalesintheprevioustimeperiod.TheexampleutilizestheFoodMartOLAPcubethatisinstalledwithMicrosoftSQLServer7.0OLAPServices.

SubTestAddCalculatedTotal()

DimstrExpDimtotCalcTotalDimvwView

SetvwView=PivotTable1.ActiveView

'TheMDXexpressionusedforthenewcalculatedtotal.strExp="([Measures].[StoreSales],Time.PrevMember)"

'Createthenewcalculatedtotal.SettotCalcTotal=vwView.AddCalculatedTotal_("SalesinLastPeriod","SalesinLastPeriod",strExp)

'InsertthecalculatedtotalinthedataareaofthePivotTable.vwView.DataAxis.InsertTotaltotCalcTotal

EndSub

AddCustomGroupFieldMethod

Addsacustomgroupfieldtoafieldset.ReturnsaPivotFieldobject.

expression.AddCustomGroupField(Name,Caption,Before)

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

NameOptionalString.Thenameforthenewfield.

CaptionOptionalString.Thecaptiontodisplayforthenewfield.

BeforeOptionalVariant.Index,name,orreferencetothefield.

RemarksOnceyouhaveusedthismethodtocreateacustomgroupfield,usetheAddCustomGroupMembermethodtoaddmemberstothegroup.

Notethatthecustomgroupfieldanditsmembersarecreatedattheclient,notthedatasource.

ExampleThisexampleaddsacustomgroupfieldtotheTimefieldset,andthenaddstwomemberstothefield.

SubCreateCustomGroup()

DimfsTimeDimfsHalfYear

'SetavariabletotheTimefieldset.SetfsTime=PivotTable1.ActiveView.FieldSets("Time")

'Addacustomgroupfieldnamed"Group1"totheTimefieldset.SetfsHalfYear=fsTime.AddCustomGroupField("Group1","Group1",_"Quarter")'Addamembertothecustomfieldset.Thismemberincludesall"Q1"'and"Q2"membersunder1997.fsHalfYear.AddCustomGroupMemberfsTime.Member.Childmembers("1997").Name,_Array("Q1","Q2"),"1stHalf"

'Addamembertothecustomfieldset.Thismemberincludesall"Q3"'and"Q4"membersunder1997.fsHalfYear.AddCustomGroupMemberfsTime.Member.ChildMembers("1997").Name,_Array("Q3","Q4"),"2ndHalf"

EndSub

AddCustomGroupMemberMethod

Addsamembertoacustomgroupfield.ReturnsaPivotMemberobject.

expression.AddCustomGroupMember(Parent,varChildMembers,bstrCaption)

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ParentRequiredVariant.Name,uniquename,referencetotheparentmemberforthenewmember(s).

varChildMembersRequiredVariant.Arrayofmembernames,uniquenames,ormemberreferencestoaddtothenewcustomgroupmember.

bstrCaptionOptionalString.Thecaptiontodisplayforthenewmember.

RemarksUsethismethodtopopulateafieldcreatedusingtheAddCustomGroupFieldmethod.

ExampleThisexampleaddsacustomgroupfieldtotheTimefieldset,andthenaddstwomemberstothefield.

SubCreateCustomGroup()

DimfsTimeDimfsHalfYear

'SetavariabletotheTimefieldset.SetfsTime=PivotTable1.ActiveView.FieldSets("Time")

'Addacustomgroupfieldnamed"Group1"totheTimefieldset.SetfsHalfYear=fsTime.AddCustomGroupField("Group1","Group1",_"Quarter")'Addamembertothecustomfieldset.Thismemberincludesall"Q1"'and"Q2"membersunder1997.fsHalfYear.AddCustomGroupMemberfsTime.Member.Childmembers("1997").Name,_Array("Q1","Q2"),"1stHalf"

'Addamembertothecustomfieldset.Thismemberincludesall"Q3"'and"Q4"under1997.fsHalfYear.AddCustomGroupMemberfsTime.Member.ChildMembers("1997").Name,_Array("Q3","Q4"),"2ndHalf"

EndSub

AddFieldSetMethod

AddsacustomfieldsettoaPivotTable.Onceyouhavecreatedacustomfieldset,youcanusetheAddCalculatedFieldmethodtodefineacustomfield.ReturnsaPivotFieldSetobject.

expression.AddFieldSet(Name)

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

NameRequiredString.Specifiesthenameofthenewfieldset.ThenamemustbeuniquewithinthethePivotFieldSetscollection.Mustbebetween1and24charactersinlength.

RemarksYoumustaddacalculatedfieldtothenewfieldsetbeforeyouaddittothecurrentPivotTableview.Customfieldsetscancontainonlyonecalculatedfield.Addingasecondcalculatedfieldtoacustomfieldsetresultsinarun-timeerror.

NoteYoucanaddacustomfieldsettoyourPivotTableifthePivotTableisconnectedtoanonlineanalyticalprocessing(OLAP)datasource,butthefieldsetwillnotworkwiththedatasource.

ExampleThisexampleaddsacalculatedfieldnamed"Variance"toanewfieldsetinPivotTable1.ThecalculatedfieldistheninsertedintothePivotTableview.

SubTestAddFieldSet()DimvwViewDimfsNewFieldSet

SetvwView=PivotTable1.ActiveView

'AddacustomfieldsettothePivotTable.SetfsNewFieldSet=vwView.AddFieldSet("Variance")

'Addacalculatedtotaltothenewlycreatedfieldset.fsNewFieldSet.AddCalculatedField"Variance",_"BudgetVariance","fldVariance",_"Budget/Actual"

'Insertthecalculatedfieldintothedataaxis.vwView.DataAxis.InsertFieldSetfsNewFieldSet

EndSub

AddInMethod

Addsanadd-intothespecifiedspreadsheet.

expression.AddIn(AddIn)

expressionAnexpressionthatreturnsaSpreadsheetobject.

AddInRequiredObject.Specifiestheadd-in.

AddNewMethod

Createsanewschemarowsourceandarecordsetdefinition.ReturnsaRecordsetDefobject.

expression.AddNew(Source,RowsourceType,Name)

expressionAnexpressionthatreturnsaRecordsetDefsobject.

SourceRequiredString.SpecifiescommandtextforanewschemarowsourceoftypedscCommandTextordscCommandFile,orforthenameofatable,view,orstoredproceduretobeaddedasaschemarowsource.Formoreinformation,seetheHelptopicfortheCommandTextproperty.

RowsourceTypeOptionalVariant.Specifiesthetypeofthenewschemarowsource.CanbeoneofthedscRowsourceTypeEnumconstants.ThedefaultconstantisdscCommandText.

NameOptionalVariant.Specifiesthenameoftherecordsetdefinition,pagerowsource,andschemarowsourcecreatedbyusingtheAddNewmethod.IfyoudonotspecifythisargumentandthevalueoftheRowsourceTypeargumentisdscTable,dscView,ordscProcedure,thenewnameisthesameasthenamespecifiedintheSourceargument(withnumeralsautomaticallyappendedtoittomakeitunique,ifnecessary).IfyoudonotspecifythisargumentandthevalueoftheRowsourceTypeargumentisdscCommandTextordscCommandFile,thenewnameis"CommandN",whereNisoneormoreappendednumerals.

RemarksPagefieldsarenormallycreatedwithnamesthatareuniquethroughoutthepagedatadefinition.However,whenapagefieldisaddedtoarecordsetdefinitionwhoseprimarypagerowsourceisoftypedscProcedure,dscCommandText,ordscCommandFile,thepagefieldnamemustbethesameastheschemafieldname.ThiscanresultinmultiplepagefieldobjectswiththesamenameintheAllPageFieldscollection.Todifferentiatebetweenobjectswiththesamename,youcanusetheexpressionAllPageFields("RecordsetdefName.PagefieldName")whereRecordsetdefNameisthenameoftherecordsetdefinition,andPagefieldNameisthenameofthepagefield.Notethatpagefieldnamesthemselvescannotcontainperiods.

ShowAll

AddTotalMethod

AddTotalmethodasitappliestotheGroupingDefsobject.

AddTotalmethodasitappliestothePivotViewobject.

ExampleAsitappliestothePivotViewobject.

ApplyMethod

AppliesthespecifiedAutoFilter.YoutypicallyusetheAutoFiltermethodtoturnontheAutoFilterandaddoneormorecriteriatoit;youcanthenusetheApplymethodtoapplythenewfilter.

expression.Apply

expressionAnexpressionthatreturnsanAutoFilterobject.

ExampleThisexampleturnsontheAutoFilterfortherangeA1:C20,setsfiltersforcolumnsAandC,andthenappliesthefilters.

PrivateSubEnableAutoFilter()DimafFiltersDimafCol1DimafCol3

'TurnonAutoFilter.Spreadsheet1.Worksheets("Sheet1").Range("A1:C20").AutoFilter

'SetavariabletotheAutoFilterobject.SetafFilters=Spreadsheet1.Worksheets("sheet1").AutoFilter

SetafCol1=afFilters.Filters(1)SetafCol3=afFilters.Filters(3)

'AddacriteriathatexcludesbluefromcolumnA.afCol1.Criteria.Add"blue"

'AddacriteriathatexcludesgreenfromcolumnA.afCol1.Criteria.Add"green"

'Addacriteriathatexcludesyellowfromcolumnc.afCol3.Criteria.Add"yellow"

'Applythecriteria.afFilters.ApplyEndSub

ApplyFilterMethod

Filterstherecordonadataaccesspagebaseduponthecurrentlyselectedfield.EquivalentinfunctionalitytotheFilterbySelectionbuttonontherecordnavigationcontrol.

expression.ApplyFilter

expressionRequired.AnexpressionthatreturnsaDataPageobject.

RemarksThismethodreliesuponthecurrentselectiononthedataaccesspagetodeterminethefieldtofilterby.Therefore,youmustsetthefocustothefieldtosortby,whentheprocedurecontainingthismethodisinvokedbyacontrolonthedataaccesspage,suchasacommandbutton.

ExampleThisexamplefiltersthedataaccesspagebaseduponthecurrentlydisplayeditemintheCategoryIDfield.

SubCommand0_onclick()

MSODSC.Datapages(0).FirstSection.HTMLContainer.Children("CategoryID").Focus

MSODSC.Datapages(0).ApplyFilter

EndSub

AutoFilterMethod

DisplaysorhidestheAutoFilterdrop-downarrows.YoutypicallyusethismethodtoturnontheAutoFilterandaddoneormorecriteriatoit;youcanthenusetheApplymethodtoapplythenewfilter.

expression.AutoFilter(Field,Criteria1,Operator,Criteria2,VisibleDropDown)

expressionAnexpressionthatreturnsaRangeobject.

FieldOptionalVariant.Thisargumentisnotsupported.

Criteria1OptionalVariant.Thisargumentisnotsupported.

OperatorOptionalVariant.Thisargumentisnotsupported.

Criteria2OptionalVariant.Thisargumentisnotsupported.

VisibleDropDownOptionalVariant.Thisargumentisnotsupported.

RemarksDonotconfusethismethodwiththeAutoFilterproperty.ThismethodappliestoaRangeobjectandturnsontheAutoFilter,whereastheAutoFilterpropertyreturnstheAutoFilterobjectforagivenworksheet.

ExampleThisexampleturnsontheAutoFilterfortherangeA1:C20,setsfiltersforcolumnsAandC,andthenappliesthefilters.

SubApply_AutoFilter()DimafFiltersDimafCol1DimafCol3'TurnonAutoFilter.Spreadsheet1.Worksheets("Sheet1").Range("A1:C20").AutoFilter'SetavariabletotheAutoFilterobject.SetafFilters=Spreadsheet1.Worksheets("sheet1").AutoFilterSetafCol1=afFilters.Filters(1)SetafCol3=afFilters.Filters(3)'AddacriteriathatexcludesbluefromcolumnA.afCol1.Criteria.Add"blue"'AddacriteriathatexcludesgreenfromcolumnA.afCol1.Criteria.Add"green"'Addacriteriathatexcludesyellowfromcolumnc.afCol3.Criteria.Add"yellow"'Applythecriteria.afFilters.ApplyEndSub

AutoFitMethod

Changesthewidthofthecolumnsintherangeortheheightoftherowsintherangetoachievethebestfit.

expression.AutoFit

expressionRequired.AnexpressionthatreturnsaRangeobject.Mustbearoworarangeofrows,oracolumnorarangeofcolumns.Otherwise,thismethodgeneratesanerror.

ExampleThisexampleadjuststheselectedrowsandcolumnstothebestfit.

SubAutoFitSelection()

DimrngSelected

SetrngSelected=Spreadsheet1.Selection

rngSelected.Rows.AutoFitrngSelected.Columns.AutoFit

EndSub

AutoLayoutMethod

ResetsthespecifiedPivotTablelisttoadefaultviewconfiguration.IfthePivotTableisboundtoarecordset,afieldsetisaddedtothedataaxisforeachfieldintherecordset.IfthePivotTableisboundtoanmultidimensionaldatasource,suchasanOLAPcube,allfieldsetsareremovedfromtheaxes,clearingthecurrentview.

expression.AutoLayout(MaxDataFields)

expressionAnexpressionthatreturnsaPivotViewobject.

MaxDataFieldsOptionalLong.Specifiesthemaximumnumberoffieldsthatcanbeaddedtothedataaxisifthedatamemberisarecordset.Ifthisargumentisnotspecifiedoriszero(0),thereisnolimittothenumberoffieldsthatwillbeadded.

ExampleThisexampleresetstheactiveviewforPivotTable1.

PivotTable1.ActiveView.AutoLayout

BeginObjectMethod

BeginsthedrawingsequenceforthespecifiedChChartDrawobject.

expression.BeginObject(id)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

idRequiredLong.Setthisargumenttoauniqueidentifierthatwillsubsequentlybeusedtoidentifytheobjectbeingdrawn.Setto-1toidentifytheChChartDrawobjectthathasbeenpassedintoaneventprocedure.

RemarksYoucancombinemultipledrawingelementsintoasingleuser-selectableitembyplacingthembetweencallstotheBeginObjectandEndObjectmethods.

ExampleThisexampleusestheBeforeRendereventtocancelthedrawingofthegridlinesandtheplotareaofthefirstchartinChartspace1.TheAfterRenderEventthenreplacestheplotareawithanellipsethatisdrawnafterthechartisrendered.

PrivateSubChartSpace1_BeforeRender(chartObject,Cancel)

SelectCaseTypeName(chartObject)

Case"ChGridlines"

'Cancelthedrawingofthegridlines.Cancel.Value=True

Case"ChPlotArea"

'Cancelthedrawingoftheplotarea.Cancel.Value=True

EndSelect

EndSub

PrivateSubChartSpace1_AfterRender(drawObject,chartObject)

DimchConstants

SetchConstants=ChartSpace1.Constants

'Checktoseeifthecharthasbeenrendered.IfTypeName(chartObject)="ChChart"Then

'Thenextthreelinesofcodesettheinterior'andborderpropertiesoftheellipse.drawObject.Interior.SetPresetGradient_chConstants.chGradientHorizontal,_chConstants.chGradientVariantStart,_Int((24-1+1)*Rnd+1)drawObject.Border.Weight=1drawObject.Border.Color="black"

'Beginthedrawingobject.drawObject.BeginObject1

'Drawtheellipse.drawObject.DrawEllipsechartObject.PlotArea.Left,chartObject.PlotArea.Bottom,_chartObject.PlotArea.Right,chartObject.PlotArea.Top

drawObject.EndObject

EndIf

EndSub

BeginUndoMethod

Specifiesthebeginningofanundoblock.ThismeansthatallstatementsbetweenthiscallanditscorrespondingEndUndomethodcallwillbeundonebyasinglecalltotheUndomethod.Thismakesitpossibleforyoutocombineentiremacrosintoonestatementthatcanbeeasilyundone.Undoblockscanbenested.

expression.BeginUndo

expressionAnexpressionthatreturnsaChartSpaceorSpreadsheetobject.

ExampleThisexamplecreatesanundoblockcontainingcodethatsetsthenumberformatandfontforcellD10.YoucanundoalloftheformattingbyclickingUndoonSpreadsheet1'stoolbar.

SubUndoBlock()DimrngCurrent'Enableundo.Spreadsheet1.EnableUndo=True'Startanundoblock.Spreadsheet1.BeginUndoSetrngCurrent=Spreadsheet1.Worksheets("sheet1").Range("D10")'Thefollowingthreelinesofcodeapply'variousformattingtocellD10.rngCurrent.NumberFormat="0.###"rngCurrent.Font.Color="Blue"rngCurrent.Font.Name="TimesNewRoman"'Endtheundoblock.Spreadsheet1.EndUndoEndSub

ShowAll

BorderAroundMethod

AddsabordertoarangeandsetstheColor,LineStyle,andWeightpropertiesforthenewborder.

expression.BorderAround(LineStyle,Weight,ColorIndex,Color)

expressionRequired.AnexpressionthatreturnsaRangeobject.

LineStyleOptionalVariant.Thelinestylefortheborder.CanbeaXlLineStyleconstant.

WeightOptionalXlBorderWeight.Theborderweight.

ColorIndexOptionalXlColorIndex.Thebordercolor,asanindexintothecurrentcolorpalette,orasanXlColorIndexconstant.

ColorOptionalVariant.Thebordercolor,asanRGBvalue.

RemarksYoumustspecifyeitherColorIndexorColor,butnotboth.

YoucanspecifyeitherLineStyleorWeight,butnotboth.Ifyoudon'tspecifyeitherargument,thedefaultlinestyleandweightareused.

ExampleThisexampleaddsathickredborderaroundtherangeA1:D4onSheet1.

SubAdd_Border()

DimssConstants

SetssConstants=Spreadsheet1.Constants

Spreadsheet1.Worksheets("Sheet1").Range("A1:D4")_.BorderAround,ssConstants.xlThick,3

EnbSub

CalculateMethod

Calculatestheopenworkbook,aspecificworksheetinaworkbook,oraspecifiedrangeofcellsonaworksheet.

expression.Calculate

expressionAnexpressionthatreturnsaRange,Spreadsheet,orWorksheetobject.

ExampleThisexamplecausestheactiveworksheetonthespreadsheettoberecalculated.

Spreadsheet1.ActiveSheet.Calculate

ThisexamplecausestherangeA1:G5inSheet1toberecalculated.

Spreadsheet1.Worksheets("Sheet1").Range("A1:G5").Calculate

CalculateFullMethod

Forceseveryformulaintheopenworkbooktoberecalculated.

expression.CalculateFull

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexampleforcesafullcalculationofalldatainSpreadsheet1.

Spreadsheet1.CalculateFull

ShowAll

ClearMethod

ClearmethodasitappliestotheChartSpaceobject.

ClearMethodasitappliestotheRangeobject.

ExampleAsitappliestotheChartSpaceobject.

AtisappliestotheRangeobject.

ClearContentsMethod

Deletesalldatafromthespecifiedrange.

expression.ClearContents

expressionAnexpressionthatreturnsaRangeobject.

ExampleThisexampledeletesalldatafromcellsA4:B10ontheactiveworksheetinSpreadhseet1.

Spreadsheet1.ActiveSheet.Range("A4:B10").ClearContents

ClearFormatsMethod

Deletesallformattingfromthespecifiedrange.

expression.ClearFormats

expressionAnexpressionthatreturnsaRangeobject.

ExampleThisexampleclearstheformattingfromallcellsontheactiveworksheet.

Spreadsheet1.ActiveSheet.Cells.ClearFormats

CollapseMethod

Causesthespecifiedsectiontocollapse.

expression.Collapse

expressionAnexpressionthatreturnsaSectionobject.

ShowAll

CopyMethod

CopymethodasitappliestotheSheets,Worksheet,andWorksheetsobjects.

CopymethodasitappliestotheRangeobject.

CopymethodasitappliestothePivotTableobject.

ExampleAsitappliestotheSheets,Worksheet,andSheetsobjects.

AsitappliestotheRangeobject.

AsitappliestothePivotTableobject.

CopyFromRecordsetMethod

CopiesthecontentsofanADOorDAORecordsetobjectontoaworksheet,beginningattheupper-leftcornerofthespecifiedrange.IftheRecordsetobjectcontainsfieldswithOLEobjectsinthem,thismethodfails.

expression.CopyFromRecordset(Data,MaxRows,MaxColumns)

expressionRequired.AnexpressionthatreturnsaRangeobject.

DataRequiredVariant.ThenameoftheRecordsetobjecttocopyintotherange.

MaxRowsOptionalVariant.Themaximumnumberofrecordstocopyontotheworksheet.Ifthisargumentisomitted,alltherecordsintheRecordsetobjectarecopied.

MaxColumnsOptionalVariant.Themaximumnumberoffieldstocopyontotheworksheet.Ifthisargumentisomitted,allthefieldsintheRecordsetobjectarecopied.

RemarksCopyingbeginsatthecurrentrowoftheRecordsetobject.Aftercopyingiscompleted,theEOFpropertyoftheRecordsetobjectisTrue.

Whenthismethodcopiestherecordsettotheworksheet,theresultswillbetruncatedifyoudonotspecifyarangethatislargeenoughtoholdthecontentsoftherecordset.

ExampleThisexamplecopiesarecordsetnamedrstAuthorsintotheactivesheetofSpreadsheet1startingatcellA1.

Spreadsheet1.ActiveSheet.Cells.CopyFromRecordsetrstAuthors

CutMethod

CutsthespecifiedrangeandeithermovesittotheClipboardorpastesitintoaspecifieddestinationrange.

expression.Cut(Destination)

expressionAnexpressionthatreturnsaRangeobject.

DestinationOptionalVariant.Ifyoudonotspecifythisargument,thespecifiedrangeissenttotheClipboard.IfthisargumentisaRangeobject,thesourcerangeismovedtothespecifiedrange.

ExampleThisexamplemovestheformula,data,andformattingfromcellA3tocellG7ontheactiveworksheet.

SubMoveCell()DimshtSourceSetshtSource=Spreadsheet1.ActiveSheet'MovethecontentsofcellA3tocellG7.shtSource.Range("A3").CutshtSource.Range("G7")EndSub

ShowAll

DeleteMethod

DeletemethodasitappliestotheHyperlink,ListRow,Name,PivotHyperlink,Sheets,Worksheet,Worksheets,XmlDataBinding,andXmlMapobjects.

DeletemethodasitappliestotheChAxes,ChCharts,ChSeriesCollection,ElementExtensions,GroupingDefs,GroupLevels,LookupRelationships,PageFields,ParameterValues,RecordsetDefs,SchemaFields,SchemaRelationships,SchemaRowsources,andSublistRelationshipsobjects.

DeletemethodasitappliestotheChDataLabelsCollection,ChErrorBarsCollection,ChSegmentsandChTrendlinesobjects.

DeletemethodasitappliestotheRangeobject.

ExampleAsitappliestotheChDataLabelsCollectioncollection.

DeleteCustomGroupMemberMethod

Deletesamemberfromacustomgroupfield.

expression.DeleteCustomGroupMember(CustomGroupMember)

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

CustomGroupMemberRequiredVariant.Name,uniquename,orreferencetothemembertodelete.

RemarksThismethodwillreturnarun-timeerrorifthememberreferredtobytheCustomGroupMemberargumentisnotamemberofacustomgroupfield.

DeleteFieldMethod

DeletesacalculatedfieldthatwascreatedbytheAddCalculatedFieldorAddCustomGroupFieldmethodsfromthespecifiedfieldset.

expression.DeleteField(Field)

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

FieldRequiredVariant.Thename,uniquenameorreferencetoacalculatedfieldinthefieldset.

DeleteFieldSetMethod

DeletesafieldsetthatwascreatedusingtheAddFieldSetmethod.ThefieldsetisremovedfromthePivotTableviewandfromthePivotFieldSetscollection.

expression.DeleteFieldSet(FieldSet)

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

FieldSetRequiredVariant.Thenameof,orareferenceto,acustomfieldset.

ExampleThefollowinglineofcodedeletesacustomfieldsetnamed"Variance"fromPivotTable1.

PivotTable1.ActiveView.DeleteFieldSet"Variance"

DeleteRecordMethod

Deletesarecordfromthespecifieddataaccesspage.

expression.DeleteRecord

expressionAnexpressionthatreturnsaDataPageobject.

DeleteTotalMethod

DeletesaPivotTotalobjectfromthePivotTotalscollection.Youcandeleteonlyuser-definedtotals.

expression.DeleteTotal(Total)

expressionAnexpressionthatreturnsaPivotViewobject.

TotalRequiredVariant.Specifiesthenameornumberofthetotal.

ExampleThisexampledeletesatotalnamed"TotalBudget"fromPivotTable1.

SubDelete_Total()DimvwView

SetvwView=PivotTable1.ActiveView

'Deletethetotalnamed"TotalBudget."vwView.DeleteTotalvwView.Totals("TotalBudget")EndSub

DrawEllipseMethod

Drawsanellipseonthespecifiedchart.UsethecurrentsettingsoftheBorderandInteriorpropertiestodeterminethepropertiesofthenewellipse.

expression.DrawEllipse(Left,Top,Right,Bottom)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

LeftRequiredLong.Pixelcoordinateoftheleftedgeoftheellipse.

TopRequiredLong.Pixelcoordinateofthetopedgeoftheellipse.

RightRequiredLong.Pixelcoordinateoftherightedgeoftheellipse.

BottomRequiredLong.Pixelcoordinateofthebottomedgeoftheellipse.

ExampleThisexampleusestheBeforeRendereventtocanceldrawingthegridlinesandplotareaofthefirstchartinChartspace1.TheAfterRendereventthenreplacestheplotareawithanellipsethatisdrawnafterthechartisrendered.

PrivateSubChartSpace1_BeforeRender(chartObject,Cancel)

SelectCaseTypeName(chartObject)

Case"ChGridlines"

'Cancelthedrawingofthegridlines.Cancel.Value=True

Case"ChPlotArea"

'Cancelthedrawingoftheplotarea.Cancel.Value=True

EndSelect

EndSub

PrivateSubChartSpace1_AfterRender(drawObject,chartObject)

DimchConstants

SetchConstants=ChartSpace1.Constants

'Checktoseeifthecharthasbeenrendered.IfTypeName(chartObject)="ChChart"Then

'Thenextthreelinesofcodesettheinterior'andborderpropertiesoftheellipse.drawObject.Interior.SetPresetGradient_chConstants.chGradientHorizontal,_chConstants.chGradientVariantStart,_Int((24-1+1)*Rnd+1)drawObject.Border.Weight=1drawObject.Border.Color="black"

'Beginthedrawingobject.drawObject.BeginObject1

'Drawtheellipse.drawObject.DrawEllipsechartObject.Left,chartObject.Bottom,_chartObject.Right,chartObject.Top

drawObject.EndObject

EndIf

EndSub

DrawLineMethod

Drawsalineonthespecifiedchart.UsesthecurrentsettingsoftheLinepropertytodeterminethepropertiesofthenewline.

expression.DrawLine(x0,y0,x1,y1)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

x0RequiredLong.StartingpixelcoordinateintheXplane.

y0RequiredLong.StartingpixelcoordinateintheYplane.

x1RequiredLong.EndingpixelcoordinateintheXplane.

y1RequiredLong.EndingpixelcoordinateintheYplane.

ExampleThisexampleillustrateshowyoucanusetheBeforeRenderandAfterRendereventstogethertocreatecustomgridlines.TheBeforeRendereventcancelstherenderingofthegridlinesandtheAfterRendereventdrawscustomgridlines.

SubChartSpace1_BeforeRender(chartObject,Cancel)

'Checktoseeifthenextobjecttoberendered'isagridline.IfTypeName(chartObject)="ChGridlines"Then

'Canceltherenderingofgridlines.Cancel.Value=True

EndIf

EndSub

SubChartSpace1_AfterRender(drawObject,chartObject)

DimchChart1DimplPlotAreaDimlLeftDimlRightDimlHeightDimlTopDimlIncrementDimchConstantsDimiCtr

SetchConstants=ChartSpace1.Constants

'SetavariabletothefirstchartinChartspace1.SetchChart1=ChartSpace1.Charts(0)

'Setavariabletotheplotareaofthechart.SetplPlotArea=chChart1.PlotArea

'Checktoseeiftherenderedobjectisagridline.IfTypeName(chartObject)="ChGridlines"Then

'Thenextfourlinesofcodeusetheextentsof'theplotareatocalculatethedimensionsoftheline.'tobedrawn.lLeft=plPlotArea.LeftlTop=plPlotArea.ToplRight=plPlotArea.RightlHeight=plPlotArea.Bottom-lTop

'Determinetheincrementtousebetweengridlines.'Changethedivisortoadjusttheincrement.lIncrement=lHeight/10

'Thenextthreelinesofcodesetthepropertiesofthe'linetobedrawn.drawObject.Line.DashStyle=chConstants.chLineRoundDotdrawObject.Line.Color="Green"drawObject.Line.Weight=chConstants.owcLineWeightMedium

ForiCtr=1To9

'Drawtheline.drawObject.DrawLinelLeft,lTop+iCtr*lIncrement,_lRight,lTop+iCtr*lIncrement

Next

EndIf

EndSub

DrawPolygonMethod

Drawsapolygononthechart.ThepointsforthepolygonarespecifiedinarrayscontainingtheXandYvaluesthatdescribethesegmentsofthepolygon.UsesthecurrentsettingsoftheBorderandInteriorpropertiestodeterminethepropertiesofthenewpolygon.

expression.DrawPolygon(xValues,yValues)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

xValuesRequiredVariant.AnarraycontainingtheXvaluesusedtocalculatethepolygon.

yValuesRequiredVariant.AnarraycontainingtheYvaluesusedtocalculatethepolygon.

ExampleThisexampleusestheBeforeRendereventtocancelrenderingthecharttitleandtheAfterRendereventtoreplacethecharttitlewithapolygon.

PrivateSubChartSpace1_BeforeRender(chartObject,Cancel)

IfTypeName(chartObject)="ChTitle"ThenCancel.Value=TrueEndIf

EndSub

SubChartSpace1_AfterRender(drawObject,chartObject)

DimalXValues(9)DimalYValues(9)DimchConstantsDimiCutoff

iCutoff=20

SetchConstants=ChartSpace1.Constants

IfTypeName(chartObject)="ChTitle"Then

'Setthearraycontainingthexvaluesfor'theline.alXValues(0)=chartObject.Left+iCutoffalXValues(1)=chartObject.Right-iCutoffalXValues(2)=chartObject.RightalXValues(3)=chartObject.Right

alXValues(4)=chartObject.Right-iCutoffalXValues(5)=chartObject.Left+iCutoffalXValues(6)=chartObject.LeftalXValues(7)=chartObject.LeftalXValues(8)=chartObject.Left+iCutoff

'Setthearraycontainingtheyvaluesfor'theline.alYValues(0)=chartObject.TopalYValues(1)=chartObject.TopalYValues(2)=chartObject.Top+iCutoffalYValues(3)=chartObject.Bottom-iCutoffalYValues(4)=chartObject.BottomalYValues(5)=chartObject.BottomalYValues(6)=chartObject.Bottom-iCutoffalYValues(7)=chartObject.Top+iCutoffalYValues(8)=chartObject.Top

'Setthepropertiesforthepolygon.drawObject.Interior.SetTwoColorGradientchConstants.chGradientFromCenter,_chConstants.chGradientVariantStart,"Red","Green"

'Drawthepolygon.drawObject.DrawPolygonalXValues,alYValues

EndIf

EndSub

DrawPolyLineMethod

Drawsalinecontainingmultiplesegments.ThepointsforthelinearespecifiedinarrayscontainingtheXandYvaluesthatdescribethesegmentsoftheline.UsesthecurrentsettingsoftheLinepropertytodeterminethepropertiesofthenewline.

expression.DrawPolyLine(xValues,yValues)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

xValuesRequiredVariant.AnarraycontainingtheXvaluesusedtocalculatetheline.

yValuesRequiredVariant.AnarraycontainingtheYvaluesusedtocalculatetheline.

ExampleThisexampleusestheAfterRendereventtodrawacustomborderaroundChartspace1.

SubChartSpace1_AfterRender(drawObject,chartObject)

DimalXValues(9)DimalYValues(9)DimiCutOffDimchConstants

iCutOff=10

SetchConstants=ChartSpace1.Constants

IfTypeName(chartObject)="ChChart"Then

'Setthearraycontainingthexvaluesfor'theline.alXValues(0)=chartObject.Left+iCutOffalXValues(1)=chartObject.Right-iCutOffalXValues(2)=chartObject.RightalXValues(3)=chartObject.RightalXValues(4)=chartObject.Right-iCutOffalXValues(5)=chartObject.Left+iCutOffalXValues(6)=chartObject.LeftalXValues(7)=chartObject.LeftalXValues(8)=chartObject.Left+iCutOff

'Setthearraycontainingtheyvaluesfor'theline.

alYValues(0)=chartObject.TopalYValues(1)=chartObject.TopalYValues(2)=chartObject.Top+iCutOffalYValues(3)=chartObject.Bottom-iCutOffalYValues(4)=chartObject.BottomalYValues(5)=chartObject.BottomalYValues(6)=chartObject.Bottom-iCutOffalYValues(7)=chartObject.Top+iCutOffalYValues(8)=chartObject.Top

'Setthepropertiesfortheline.drawObject.Line.Color="blue"drawObject.Line.Weight=chConstants.owcLineWeightThickdrawObject.Line.DashStyle=chConstants.chLineLongDashDot

'Drawtheline.drawObject.DrawPolyLinealXValues,alYValues

EndIf

EndSub

DrawRectangleMethod

Drawsarectangleonachart.UsesthecurrentsettingsoftheBorderandInteriorpropertiestodeterminethepropertiesofthenewrectangle.

expression.DrawRectangle(Left,Top,Right,Bottom)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

LeftRequiredLong.Pixelcoordinateoftheleftedgeoftherectangle.

TopRequiredLong.Pixelcoordinateofthetopedgeoftherectangle.

RightRequiredLong.Pixelcoordinateoftherightedgeoftherectangle.

BottomRequiredLong.Pixelcoordinateofthebottomedgeoftherectangle.

ExampleThisexampleusestheAfterRendereventtodrawrectanglesasasubstituteforthelegendentriesinthefirstchartofChartspace1.

SubChartSpace1_AfterRender(drawObject,chartObject)

DimchConstants

SetchConstants=ChartSpace1.Constants

IfTypeName(chartObject)="ChLegendEntry"Then

'Settheinterioroftherectangletoapresettexture.'YoucouldsubstituteaURLtoacustomgraphic'forthetexture.drawObject.Interior.SetTexturedchConstants.chTextureSand

'Begindrawingtherectangle.drawObject.BeginObject1

'Drawtherectangle.drawObject.DrawRectanglechartObject.Left,chartObject.Top,_chartObject.Right,chartObject.Bottom

drawObject.EndObject

EndIf

EndSub

DrawTextMethod

Drawsatextstringonachart.

expression.DrawText(bstrText,Left,Top)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

bstrTextRequiredString.Thetexttodrawonthechart.

LeftRequiredLong.Pixelcoordinateoftheleftedgeofthetext.

TopRequiredLong.Pixelcoordinateofthetopedgeofthetext.

ExampleThisexampleaddsatextstringtotheupper-leftcorneroftheplotareaeachtimethatthechartisre-drawn.

SubChartSpace1_AfterRender(drawObject,chartObject)

DimchChart1

SetchChart1=ChartSpace1.Charts(0)'Afterthelegendhasbeenrendered,thenaddthetext'tothechart.IfTypeName(chartObject)="ChLegend"ThendrawObject.DrawText"2000Sales",chChart1.PlotArea.Left+5,_chChart1.PlotArea.TopEndIf

EndSub

ShowAll

DropZonesMethod

ReturnsaChDropZoneobject.Usethepropertiesofthereturnedobjecttoformatthedropzone.

expression.DropZones(dz)

expressionRequired.AnexpressionthatreturnsaChartspaceobject.

dzRequiredChartDropZonesEnum.Representsthedropzonethatyouwanttoformat.

ExampleThisexampleformatsthebuttonandthewatermarkoftheseriesdropzoneinChartspace1.

SubSetupDropZone()

DimdzSeriesDropZoneDimchConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Thenextthreelinesofcodeformatthebuttonofthedropzone.dzSeriesDropZone.ButtonBorder.Weight=chConstants.owcLineWeightMediumdzSeriesDropZone.ButtonInterior.SetSolid"Red"dzSeriesDropZone.ButtonFont.Size=14

'Thenextthreelinesofcodeformatthewatermarkofthedropzone.dzSeriesDropZone.WatermarkBorder.Color="Red"dzSeriesDropZone.WatermarkFont.Color="Red"dzSeriesDropZone.WatermarkInterior.SetSolid"Green"

EndSub

DuplicateFormatMethod

Copiestheformattingandtypeofthespecifiedcharttootherchartsintheworkspacethatareboundtothesamedatasource.Thismethodcanonlybeusedwhenthechartcontrolisboundtoarelationaldatasourcelist.

expression.DuplicateFormat

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksTheHasMultipleChartspropertyofthechartcontrolmustbesettoTruebeforeusingthismethod.

ExampleThisexamplecopiestheformattingofthefirstchartinChartspace1toallotherchartsinChartspace1thatareboundtothesamePivotTablelist.

Chartspace1.Charts(0).DuplicateFormat

EndEditMethod

Movestheactivecelloutofeditmode.

expression.EndEdit(Accept)

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

AcceptOptionalBoolean.Specifieswhetherthecurrentvalueisaccepted.SettingthisargumenttoFalsediscardsanychangestothedetailcellandthepreviousvalueisrestored.ThedefaultvalueisTrue.

EndObjectMethod

EndsthedrawingsequenceforthespecifiedChChartDrawobject.

expression.EndObject

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

ExampleThisexampleusestheBeforeRendereventtocanceldrawingthegridlinesandplotareaofthefirstchartinChartspace1.TheAfterRendereventthenreplacestheplotareawithanellipsethatisdrawnafterthechartisrendered.

PrivateSubChartSpace1_BeforeRender(chartObject,Cancel)

SelectCaseTypeName(chartObject)

Case"ChGridlines"

'Cancelthedrawingofthegridlines.Cancel.Value=True

Case"ChPlotArea"

'Cancelthedrawingoftheplotarea.Cancel.Value=True

EndSelect

EndSub

PrivateSubChartSpace1_AfterRender(drawObject,chartObject)

DimchConstants

SetchConstants=ChartSpace1.Constants

'Checktoseeifthecharthasbeenrendered.IfTypeName(chartObject)="ChChart"Then

'Thenextthreelinesofcodesettheinterior'andborderpropertiesoftheellipse.drawObject.Interior.SetPresetGradient_chConstants.chGradientHorizontal,_chConstants.chGradientVariantStart,_Int((24-1+1)*Rnd+1)drawObject.Border.Weight=1drawObject.Border.Color="black"

'Beginthedrawingobject.drawObject.BeginObject1

'Drawtheellipse.drawObject.DrawEllipsechartObject.Left,chartObject.Bottom,_chartObject.Right,chartObject.Top

drawObject.EndObject

EndIf

EndSub

EndUndoMethod

Specifiestheendofanundoblock.ThismeansthatallstatementsbetweenthiscallanditscorrespondingBeginUndomethodcallwillbeundonebyasinglecalltotheUndomethod.Thismakesitpossibleforyoutocombineentiremacrosintoonestatementthatcanbeeasilyundone.Undoblockscanbenested.

expression.EndUndo

expressionAnexpressionthatreturnsaChartSpaceorSpreadsheetobject.

ExampleThisexamplecreatesanundoblockcontainingcodethatsetsthenumberformatandfontforcellD10.YoucanundoalloftheformattingbyclickingUndoonSpreadsheet1'stoolbar.

SubUndoBlock()DimrngCurrent'Enableundo.Spreadsheet1.EnableUndo=True'Startanundoblock.Spreadsheet1.BeginUndoSetrngCurrent=Spreadsheet1.Worksheets("sheet1").Range("D10")'Thefollowingthreelinesofcodeapply'variousformattingtocellD10.rngCurrent.NumberFormat="0.###"rngCurrent.Font.Color="Blue"rngCurrent.Font.Name="TimesNewRoman"'Endtheundoblock.Spreadsheet1.EndUndoEndSub

EuroConvertMethod

YoucanusetheEuroConvertmethodtoconvertanumbertotheeuroorfromtheeurotoaparticipatingcurrency.Youcanalsouseittoconvertanumberfromoneparticipatingcurrencytoanotherbyusingtheeuroasanintermediary(triangulation).TheEuroConvertmethodusesfixedconversionratesestablishedbytheEuropeanCommission.ReturnsaDoublevalue.

expression.euroConvert(Number,SourceCurrency,TargetCurrency,FullPrecision,TriangulationPrecision)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

NumberRequiredDouble.Thenumberyouwanttoconvert.

SourceCurrencyRequiredString.Astringexpression,orreferencetoafieldcontainingthestring,correspondingtotheInternationalStandardsOrganization(ISO)acronymforthecurrencyyouwanttoconvert.CanbeoneoftheISOcodeslistedinthefollowingtable.

CurrencyISOCode

CalculationPrecision

DisplayPrecision

Belgianfranc BEF 0 0Luxembourgfranc LUF 0 0Deutschemark DEM 2 2Spanishpeseta ESP 0 0Frenchfranc FRF 2 2Irishpunt IEP 2 2Italianlira ITL 0 0Netherlandsguilder NLG 2 2Austrianschilling ATS 2 2Portugueseescudo PTE 1 2finishMarkka FIM 2 2euro EUR 2 2Intheprecedingtable,thecalculation

precisiondetermineswhatcurrencyunittoroundtheresulttobasedontheconversioncurrency.Forexample,whenconvertingtoDeutschemarks,thecalculationprecisionis2,andtheresultisroundedtothenearestpfennig,100pfennigstoamark.Thedisplayprecisiondetermineshowmanydecimalplacesappearinthefieldcontainingtheresult.

LaterversionsoftheEuroConvertmethodmaysupportadditionalcurrencies.

Currency ISOCodeDanishKrone DKKDrachma GRDSwedishKrona SEKPoundSterling GBP

TargetCurrencyRequiredString.Athree-letterstringcorrespondingtotheISOcodeofthecurrencytowhichyouwanttoconvertthenumber.SeetheprevioustablefortheISOcodes.ForalistofISOcodes,seetheSourceCurrencyargumentdescription.

FullPrecisionOptionalVariant.Alogicalvalue(TrueorFalse),oranexpressionthatevaluatestoavalueofTrueorFalse,thatspecifieshowtodisplaytheresult.

Use IfyouwanttoFalse Displaytheresultwiththecurrency-specificroundingrules(see

thetableintheSourceCurrencyargumentdescription).Thecalculationprecisionvalueisusedtocalculatetheresultandthedisplayprecisionvaluetodisplaytheresult.FalseisthedefaultiftheFullPrecisionargumentisomitted.

True Displaytheresultwithallsignificantdigitsresultingfromthecalculation.

TriangulationPrecisionOptionalVariant.Avaluegreaterthanorequalto3thatspecifiesthenumberofsignificantdigitsinthecalculation

precisionusedfortheintermediateeurovaluewhenconvertingbetweentwonationalcurrencies.

RemarksAnytrailingzerosaretruncatedandinvalidparametersreturn#Error.

IfthesourceISOcodeisthesameasthetargetISOcode,theoriginalvalueofthenumberisactive.

Thismethoddoesnotapplyaformat.

TheEuroConvertmethodusesthecurrentratesestablishedbytheEuropeanCommission.Iftherateschange,Microsoftwillupdatethemethod.Togetfullinformationabouttherulesandtheratescurrentlyineffect,seetheEuropeanCommissionpublicationsabouttheeuro.

ExampleThisexampleconvertsthevalueoftheUnitPricefieldfromFrenchfrancstoeuros.

DubConvertToEuros()

DimdblSourceNumDimdblConvertedNum

'SetavariabletotheUnitPricefield.dblSourceNum=Document.All("unitprice").Value'ConverttheUnitPricefromFrenchfrancstoeuros.dblConvertedNum=MSODSC.EuroConvert(dblsourcenum,"FRF","EUR",False,3)'PlacetheconvertedvalueintheEuroValuefield.Document.All("EuroValue").Value=dblConvertedNumEndSub

EvaluateMethod

Evaluatesanexpressionthatisintheformoftextandreturnstheresult.Theexpressioncanincludeanycombinationoffunctions,keywords,orothersyntaxthattheSpreadsheetComponentcanresolve.

expression.Evaluate(Expression)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExpressionRequiredVariant.Theexpressiontoevaluate.

RemarksThefollowingtypesofnamesinMicrosoftExcelcanbeusedwiththismethod:

A1-stylereferences.YoucanuseanyreferencetoasinglecellinA1-stylenotation.Allreferencesareconsideredtobeabsolutereferences.

Ranges.Youcanusetherange,intersect,andunionoperators(colon,space,andcomma,respectively)withreferences.

Definednames.Youcanspecifyanynameinthelanguageofthemacro.

ExampleThisexampleusesthetheEvaluatemethodtocalculatethecotangentofanangle.

FunctionCalcCotangent(sngAngleInDegrees)

DimstrExpression

'Puttogethertheexpressiontocalculatethecotangent'oftheangle.strExpression="1/TAN("&sngAngleInDegrees&"*PI()/180)"

'Evaluatethestringandreturntheresult.CalcCotangent=Spreadsheet1.ActiveSheet.Evaluate(strExpression)

EndFunction

ShowAll

ExecuteMethod

ExecutemethodasitappliestotheDataSourceControlobject.

ExecutemethodasitappliestotheOCCommandobject.

ExpandMethod

Causesthespecifiedsectiontoexpand.

expression.Expand

expressionAnexpressionthatreturnsaSectionobject.

ShowAll

ExportMethod

ExportmethodasitappliestotheandPivotTableobject.

ExportmethodasitappliestotheSpreadsheetobject.

ExampleAsitappliestotheSpreadsheetobject.

ExportMetaDataMethod

UsethismethodtoreturnaVariant(String)thatcontainsthe<pagingInfo>tagfromthedataretrievalservicesqueryresponsefromthemostrecentbindingrefreshoperation.

expression.ExportMetaData(ShowDialogs)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ShowDialogsOptionalBoolean.SpecifieswhetheradialogboxisdisplayediftheExportMetaDatamethodencountersanerrorthatisreturnedbytheSpreadsheetcomponentitself.WhenShowDialogsissettoTrue,adialogboxisdisplayediftheExportMetaDatamethodencountersanerrorreturnedbytheSpreadsheetcomponent.WhenShowDialogsissettoFalse,dialogboxesforSpreadsheetcomponenterrorsarenotdisplayed.ThedefaultisFalse.

NoteTheShowDialogsargumentdoesnotcontrolwhetheradialogboxwillbedisplayedforerrorsexternaltotheSpreadsheetcomponent,suchaserrorsreturnedbyscriptingcomponents.TopreventadialogboxfromdisplayingforerrorsexternaltotheSpreadsheetcomponent,youmusttrapthoseerrorsinyourscript.

Remarks

The<pagingInfo>tagwillnotalwaysbepresentinthequeryresponse.Whenitisnotpresent,theExportMetaDatamethodwillreturnanemptyString.

ExportPictureMethod

SavesthespecifiedchartworkspaceorPivotTablelistasagraphicsfile.

expression.ExportPicture(FileName,FilterName,Width,Height)

expressionAnexpressionthatreturnsaChartSpaceorPivotTableobject.

FileNameOptionalString.Specifiesthenameofthesavedfile.Ifyoudonotspecifythisargument,thedefaultfilenameis“Chart.gif”forachartworkspaceor“Pivot.gif”foraPivotTablelist.

FilterNameOptionalString.Specifiesthenameofthegraphicsfilterthatisused.SupportedfilternamesareGIF,JPG,andPNG.ThedefaultisGIF.

WidthOptionalLong.Specifiesthewidthofthegraphic,inpixels.Youmustspecifythisargumentforserver-sidecharts.

HeightOptionalLong.Specifiestheheightofthegraphic,inpixels.Youmustspecifythisargumentforserver-sidecharts.

ExampleThisexamplesavesthechartworkspaceasagraphicsfile.

ChartSpace1.ExportPicture"sales.gif","gif",320,240

ShowAll

ExportXMLMethod

AsitappliestotheDataSourceControlobject.

AsitappliestotheXmlMapobject.

ExampleAsitappliestotheDataSourceControlobject.

FillDownMethod

Fillsdownfromthetopcellorcellsinthespecifiedrangetothebottomoftherange.Thecontentsandformattingofthecellorcellsinthetoprowarecopiedintotherestoftherowsintherange.

expression.FillDown

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplefillstherangeA1:A10ontheactiveworksheet,basedonthecontentsofcellA1.

Spreadsheet1.ActiveSheet.Range("A1:A10").FillDown

FillRightMethod

Fillsrightfromtheleftmostcellorcellsinthespecifiedrange.Thecontentsandformattingofthecellorcellsintheleftmostcolumnarecopiedintotherestofthecolumnsintherange.

expression.FillRight

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplefillstherangeA1:M1ontheactiveworksheet,basedonthecontentsofcellA1.

Spreadsheet1.ActiveSheet.Range("A1:M1").FillRight

ShowAll

FindMethod

FindsspecificinformationinagivenrangeandreturnsaRangeobjectthatrepresentsthefirstcellwherethatinformationisfound.ReturnsNothingifnomatchisfound.Doesnotaffecteithertheselectionortheactivecell.

expression.Find(What,After,LookIn,LookAt,SearchOrder,SearchDirection,MatchCase,MatchByte)

expressionAnexpressionthatreturnsaRangeobject.

WhatRequiredVariant.Thedatatobesearchedfor.

AfterOptionalVariant.Specifiesasinglecellafterwhichthesearchbegins.Thiscorrespondstothepositionoftheactivecellwhenasearchisdonefromtheuserinterface.Rememberthatthesearchbeginsafterthiscell;thespecifiedcellisn’tsearcheduntilthemethodwrapsbackaroundtothiscell.Ifyoudon’tspecifythisargument,thesearchstartsafterthecellintheupper-leftcorneroftherange

LookInOptionalXlFindLookIn.Specifieswhethertosearchformulasorthedisplayedvalue.

LookAtOptionalXlLookAt.SetthisargumenttoxlWholetoforcetheentirecontentsofthecelltomatchthecontentsoftheWhatargument.

SearchOrderOptionalXlSearchOrder.Specifieswhethertosearchbycolumnsorrows.

SearchDirectionOptionalXlSearchDirection.Specifiesthesearchdirection.

MatchCaseOptionalBoolean.Truetomakethesearchcasesensitive.ThedefaultvalueisFalse.

MatchByteOptionalVariant.Usedonlyifyou’veselectedorinstalleddouble-bytelanguagesupport.Truetohavedouble-bytecharactersmatchonlydouble-bytecharacters.Falsetohavedouble-bytecharactersmatchtheirsingle-byteequivalents.

ExampleThisexamplefindsalloccurrencesof"Mike"intherangeA1:F10andmakesthosecellsbold.

SubFind_Mike()DimssConstantsDimrngFindRangeDimrngFoundCellDimrngFirstFound

SetssConstants=Spreadsheet1.Constants

'Setavariabletotherangetosearch.SetrngFindRange=Spreadsheet1.Sheets("Sheet1").Range("A1:F10")

'FindthefirstoccurrenceofMike.SetrngFoundCell=rngFindRange.Find("Mike",rngFindRange.Cells(1,1),_ssConstants.xlValues,ssConstants.xlPart)

'IfMikewasfound...IfNotrngFoundCellIsNothingThen

'Setavariabletothefirstfoundinstance.SetrngFirstFound=rngFoundCell

Do'Setthefonttobold.rngFoundCell.Font.Bold=True

'FindthenextoccurrenceofMike.SetrngFoundCell=rngFindRange.FindNext(rngFoundCell)

'LoopuntilyoureturntothefirstoccurrenceofMike.LoopUntilrngFoundCell.Address=rngFirstFound.AddressEndIfEndSub

FindNextMethod

ContinuesasearchthatwasbegunwiththeFindmethod.FindsthenextcellthatmatchesthosesameconditionsandreturnsaRangeobjectthatrepresentsthatcell.Doesn’taffecttheselectionortheactivecell.

expression.FindNext(After)

expressionRequired.AnexpressionthatreturnsaRangeobject.

AfterOptionalVariant.Thecellafterwhichyouwanttosearch.Thiscorrespondstothepositionoftheactivecellintheuserinterface.NotethatAftermustbeasinglecellintherange.Rememberthatthesearchbeginsaftertheactivecell;theactivecellitselfisn’tsearcheduntiltheFindNextmethodwrapsbackaroundtotheactivecell.Ifthisargumentisn’tspecified,thesearchstartsafterthecellintheupper-leftcorneroftherange.

ExampleThisexamplefindsalloccurrencesof"Mike"inSheet1andmakesthosecellsbold.

SubFindMike()

DimssConstantsDimrngFindRangeDimrngFoundCellDimrngFirstFound

SetssConstants=Spreadsheet1.Constants

'Setavariabletotherangetosearch.SetrngFindRange=Spreadsheet1.Sheets("Sheet1").UsedRange

'FindthefirstocurenceofMike.SetrngFoundCell=rngFindRange.Find("Mike",rngFindRange.Cells(1,1),_ssConstants.xlValues,ssConstants.xlPart)

'IfMikewasfound...IfNotrngFoundCellIsNothingThen

'Setavariabletothefirstfoundinstance.SetrngFirstFound=rngFoundCell

Do'Setthefonttobold.rngFoundCell.Font.Bold=True

'FindthenextoccurrenceofMike.

SetrngFoundCell=rngFindRange.FindNext(rngFoundCell)

'LoopuntilyoureturntothefirstoccurrenceofMike.LoopUntilrngFoundCell.Address=rngFirstFound.Address

EndIf

EndSub

FindPreviousMethod

ContinuesasearchthatwasbegunwiththeFindmethod.FindsthepreviouscellthatmatchesthosesameconditionsandreturnsaRangeobjectthatrepresentsthatcell.Doesn’taffecttheselectionortheactivecell.

expression.FindPrevious(After)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

AfterOptionalVariant.Thecellbeforewhichyouwanttosearch.Thiscorrespondstothepositionoftheactivecellintheuserinterface.NotethatAftermustbeasinglecellintherange.Rememberthatthesearchbeginsbeforetheactivecell;theactivecellitselfisn’tsearcheduntiltheFindPreviousmethodwrapsbackaroundtothiscell.Ifthisargumentisn’tspecified,thesearchstartsbeforetheupper-leftcellintherange.

ExampleThisexampleshowshowtheFindPreviousmethodisusedwiththeFindandFindNextmethods.Beforerunningthisexample,makesurethatSheet1containsatleasttwooccurrencesoftheword“Redmond”incolumnB.

SubFind_Methods()

DimrngFoundCellDimrngFindRange

'Setavariabletotherangetosearch.SetrngFindRange=Spreadsheet1.ActiveSheet.Columns("B")

'FindthefirstoccurenceofRedmondincolumnB.SetrngFoundCell=rngFindRange.Find("Redmond")

'DisplaythelocationofthefirstoccurenceofRedmond.MsgBox"Thefirstoccurrenceisincell"&rngFoundCell.Address

'FindthenextoccurenceofRedmondincolumnB.SetrngFoundCell=rngFindRange.FindNext(after:=rngFoundCell)

'DisplaythelocationofthenextoccurenceofRedmond.MsgBox"Thenextoccurrenceisincell"&rngFoundCell.Address

'FindthepreviousoccurenceofRedmondincolumnB.SetrngFoundCell=rngFindRange.FindPrevious(after:=rngFoundCell)

'DisplaythelocationofthepreviousoccurenceofRedmond.MsgBox"Thepreviousoccurrenceisincell"&rngFoundCell.Address

EndSub

FireParametersOutMethod

UsethisthismethodtotriggertheParametersOutReadyevent.ReturnsNothing.

expression.FireParametersOut(InterfaceName,ParamArray)

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

InterfaceNameRequired.NameofaParametersOutProviderinterface,asspecifiedinthesolutionspecificationfile.

ParamArrayOptional.Onedimensionalarrayofstringsinwhicheachstringisthevalueofaparameter.Ifaparameterisnotspecified,thevaluein/ParametersOutProvider/SendParameters/Parameter/DefaultValuewillbeused.Ifbotharemissing,anerrorisreturned.

Remarks

Notethatthismethoddoesn'tapplyunlesstheSpreadsheetcomponentisrunninginthecontextofaSpreadsheetWebPartonaWebPartPageonaSharePointsite.

TheSpreadsheetWebPartcanimplementtheIParametersOutProviderinterface.TheParametersOutReadyeventistriggeredwhenaseparateWebPartthatimplementstheIParametersOutProviderinterfaceinvokesitsFireParametersOutmethod.TheParametersOutReadyeventpassesasetofdeveloper-definedparameterstoanotherWebPartthatimplementstheIParametersOutConsumerinterface.

Formoreinformationontheschemaofasolutionspecificationfile,searchtheMicrosoftDeveloperNetwork(MSDN)Websitefor"solutionspecificationfile."Forgeneralinformationonthesolutionspecificationfileandsomeexamples,searchMicrosoftOfficeExcel2003helpfor"spreadsheetwebpart."

FlipHorizontalMethod

Flipsalloftheseriesinthespecifiedcharthorizontally.

expression.FlipHorizontal

expressionAnexpressionthatreturnsaChPlotAreaobject.

ExampleThisexampleflipsalloftheseriesinthespecifiedcharthorizontally.

ChartSpace1.Charts(0).PlotArea.FlipHorizontal

FlipVerticalMethod

Flipsalloftheseriesinthespecifiedchartvertically.

expression.FlipVertical

expressionAnexpressionthatreturnsaChPlotAreaobject.

ExampleThisexampleflipsalloftheseriesinthespecifiedchartvertically.

ChartSpace1.Charts(0).PlotArea.FlipVertical

ShowAll

FollowMethod

FollowmethodasitappliestotheHyperlinkobject.

FollowmethodasitappliestothePivotHyperlinkobject.

ExampleThisexampleresolvesthehyperlinkincellB15ontheactiveworksheet,downloadsthetargetdocument,andthendisplaysthedocument.

Spreadsheet1.ActiveSheet.Range("b15").Hyperlink.Follow

GetContainingSectionMethod

ReturnsthecontainingsectionforthespecifiedHTMLelement.

expression.GetContainingSection(Element)

expressionAnexpressionthatreturnsaDataSourceControlobject.

ElementRequiredObject.RepresentsthespecifiedHTMLelement.

ShowAll

GetDataPointVisibleMethod

Returnstheindexofthedatapointthatisvisibleinthescrollview.Long.

expression.GetDataPointVisible(datapoint)

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

datapointRequiredChartDataPointEnum.

Remarks

Adatapointisconsideredvisibleonlyiftheassociatedcategoryiswithinthescrollview.Thismethodisvalidonlyforbarandcolumncharts.Forothercharttypes,thevaluereturnedisundefined.

ExampleThefollowingexampledemonstrateshowtogettheindexofthedatapointthatisvisibleinthescrollview.

DimobjSeriesDimchChartDimlngPointFirstDimlngPointLast

SetchChart=ChartSpace.Constants

'Savethelowestandhighestvisibledatapointindexvaluestovariables.lngPointFirst=_objSeries.GetDataPointVisible(chChart.chDataPointFirst)lngPointLast=_objSeries.GetDataPointVisible(chChart.chDataPointLast)

GetPictureMethod

Returnsapictureofachartfromabinarydatastream.

expression.GetPicture(FilterName,Width,Height)

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

FilterNameOptionalString.Thenameofthegraphicsfiltertouse.Thedefaultvalueis"GIF".

WidthOptionalLong.Thewidthofthechartinpixels.

HeightOptionalLong.Theheightofthechartinpixels.

RemarksYoucanusetheBinaryWritemethodtowritethepicturereturnedbythismethodtothecurrentHTTPsession.

ExampleThisexampleusesanASPscripttocreateachartbasedondatainaSQLServerdatabase.Oncethecharthasbeencreated,anpictureofthechartisdisplayedinthebrowserwindow.

<%DimPictTypeDimNewChartDimchConstants

SetNewChart=CreateObject("OWC11.ChartSpace")

Response.Expires=0Response.Buffer=TrueResponse.Clear

PictType="jpg"Response.ContentType="image/"&PictType

SetchConstants=NewChart.Constants

NewChart.ConnectionString="Provider=SQLOLEDB.1;PersistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=servername;"NewChart.DataMember="OrderDetails"

NewChart.SetDatachConstants.chDimCategories,chConstants.chDataBound,"ProductID"NewChart.SetDatachConstants.chDimValues,chConstants.chDataBound,"Quantity"

NewChart.Charts(0).Type=chConstants.chChartTypeColumn3DNewChart.Charts(0).HasTitle=True

NewChart.Charts(0).Title.Caption="Server-RenderedChart"

Response.BinaryWriteNewChart.GetPicture(PictType,500,400)%>

ShowAll

GetValueMethod

Returnsadatavalueforthespecifiedpointinacustomdatadimension.

expression.GetValue(Dimension,scaled)

expressionAnexpressionthatreturnsaChPointobject.

DimensionRequiredChartDimensionsEnum.Thedimensionfromwhichyouareretrievingthevalue.

ScaledOptionalVariant.Specifieswhethertoreturntheactualvalueofthepoint,oritspercentageasitrelatestotheotherrelatedpoints.SetthisargumenttoTruetoreturnthepercentage.ThisargumentisrelevantonlywhenyouareusingaPie,Doughnut,orStackedColumnchart.

RemarksAlternatively,youcanspecifyaChartErrorBarCustomValuesEnumconstantfortheDimensionargumenttoreturnthevalueofanerrorbar.

GroupMethod

GroupsthespecidfiedserieswiththeseriesspecifiedintheSeriesargument.

expression.Group(Series)

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

SeriesRequiredChSeriesobject.Theseriestogroupthespecifiedserieswith.

HideDetailsMethod

Hidesthedetailscellsforthespecifiedobject.IfthespecifiedobjectisaPivotDataobject,alldetailcellsarehidden.IfthespecifiedobjectisaPivotRowMemberobject,thenalldetailscellsinthatrowarehidden.IfthespecifiedobjectisaPivotColumnMemberobject,thenalldetailscellsinthatcolumnarehidden.

expression.HideDetails

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplehidesallofthedetailcellsinPivotTable1.

PivotTable1.ActiveData.HideDetails

ImportXmlMethod

Whenthismethodiscalled,thespecifiedSpreadsheetcomponentmapisupdatedwithanXMLdatastream.ReturnsNothing.

expression.ImportXml(XMLData,ShowDialogs,UseIDXPath)

expressionAnexpressionthatreturnsanXmlMapobject.

XMLDataRequiredVariant.AStringorIStreamobjectthatcontainstheXMLdatatobeimported.

ShowDialogsOptionalBoolean.SpecifieswhetheradialogboxisdisplayediftheImportXmlmethodencountersanerrorthatisreturnedbytheSpreadsheetcomponentitself.WhenShowDialogsissettoTrue,adialogboxisdisplayediftheImportXmlmethodencountersanerrorreturnedbytheSpreadsheetcomponent.WhenShowDialogsissettoFalse,dialogboxesforSpreadsheetcomponenterrorsarenotdisplayed.ThedefaultisFalse.

UseIDXPathOptionalBoolean.SpecifieshowtoimportXMLdataintoaSpreadsheetWebPartthatimplementsanIRowConsumerconnectioninterfaceintheRowConsumerelementofitssolutionspecificationfile.WhensettoFalse,theSpreadsheetWebPartimportstheXMLdataaccordingtotheXPathstatementspecifiedintheXPathelementwithintheMapelementintheXMLSpreadsheetfileassociatedwiththeWebPart.WhensettoTrue,theSpreadsheetWebPartimportstheXMLdatausingaroot/rowschema(asshownbelow),andmapstherowelementstotheFieldelementswithintheMapelementoftheXMLSpreadsheetfileassociatedwiththeWebPart.ThedefaultisFalse.

Root/RowSchema

<Root><Row><Field1>Field1Value</Field1><Field2>Field2Value</Field2></Row></Root>

TheSpreadsheetWebPartwillattempttomatcheachfieldtagname(suchasField1andField2intheschemaexampleabove)totheIDattributeofaFieldelementwithintheMapelementofanXMLSpreadsheetfile.Forexample,thefollowingXMLfragmentfromanXMLSpreadsheetfileshowsaFieldelementwithanIDattributevalueof"Field1".

<Mapx2:ID="Products_Map"x2:SchemaID="Schema1"x2:RootElement="Products"><Entryx2:Type="table"x2:ID="2"x2:ShowTotals="false"x2:NoInserts="true"><Range>Products!R2C1:R4C8</Range><HeaderRange>R1C1</HeaderRange><x:FilterOn>True</x:FilterOn><XPath>/Products/Products_Row</XPath><Fieldx2:ID="Field1"><Range>RC</Range><XPath>ProductID</XPath><XSDType>int</XSDType></Field>...

NoteTheShowDialogsargumentdoesnotcontrolwhetheradialogboxwillbedisplayedforerrorsexternaltotheSpreadsheetcomponent,suchaserrorsreturnedbyscriptingcomponents.TopreventadialogboxfromdisplayingforerrorsexternaltotheSpreadsheetcomponent,youmusttrapthoseerrorsinyourscript.

Remarks

UsetheImportXmlmethodtoimportthecontentsofanXMLdatafileintocellsorintoanXMLlistmappedtoaspecificschemamap.IfthecontentsoftheXMLdatafiletobeimporteddonotmatchthespecifiedschemamapandtheImportXmloperationfails,anerrordialogboxwillbedisplayedwhentheoptionalShowDialogsargumentissettoTrue.

TheXMLdatabeingimportedneedsto"match"theXmlMapit'sbeingimportedinto—thatis,theXPathscontainedintheXmlMapentriesandfieldsshouldcorrespondtosomeelementorattributeintheimporteddata.

Duringanasynchronousbinding,alldata-bindingobjectmodelcallsthatincludeXmlMap.ImportXmlwillreturnanerrormessagethatsaystherequestedoperationcannotbecompletedbecauseanasynchronousbindingisinprogress.Objectmodelcallswillstarttosucceedwhentheasynchronousbindingiscomplete.

ExampleThisexampleshowshowyoucanusetheCanQuerypropertytofirstcheckwhetherabindingcanbequeried.Ifitcan,thecoderefreshesthebinding.AneventhandertrapstheBindingCompletedevent,whichthencallstheExportXmlInfofunction,passinganotherinstanceoftheSpreadsheetcomponentasanargumenttothatfunction.IntheExportXmlInfofunction,theExportXMLmethodiscalledandtheXMLdatastreamisreturnedtothecallingfunctionandusedastheinputfortheImportXmlmethod.

DimobjBindingDimobjBindingsDimobjXmlStringInDimobjXmlMap

SetobjXmlMap=Spreadsheet1.ActiveWorkbook.XmlMaps.Item(1)SetobjBindings=Spreadsheet1.ActiveWorkbook.XmlDataBindings

ForEachobjBindingInobjBindingsIfobjBinding.CanQuery=TrueobjBinding.RefreshEndIfNext

SubSpreadsheet1_BindingCompleted(bindingID,Action)

DimobjXmlStringInDimobjXmlMap

'WriteoutthedatainthespecifiedmaptoanXMLdatastream.objXmlStringIn=ExportXmlInfo(Spreadsheet2)

'UsetheXMLdatastreambypassingitastheargumenttotheImportXmlmethod.objXmlMap.ImportXmlobjXmlStringIn

EndSub

FunctionExportXmlInfo(Spreadsheet2)DimobjXmlMap

SetobjXmlMap=Spreadsheet2.ActiveWorkbook.XmlMaps.Item(1)'Returnthemaptothecallingfunction.ExportXmlInfo=objXmlMap.ExportXml()EndFunction

NoteForinformationontrappingtheBindingCompletedeventfromscriptrunninginaWebpage,seetheBindingCompletedeventtopic.

InsertMethod

Insertsacellorarangeofcellsintotheworksheetandshiftsothercellsawaytomakespace.

expression.Insert(Shift)

expressionRequired.AnexpressionthatreturnsaRangeobject.

ShiftOptionalVariant.Specifieswhichwaytoshiftthecells.CanbeoneofthefollowingXlInsertShiftDirectionconstants:xlShiftToRightorxlShiftDown.Ifthisargumentisomitted,MicrosoftExceldecidesbasedontheshapeoftherange.

InsertFieldSetMethod

Insertsafieldsetonthespecifiedaxis.

expression.InsertFieldSet(FieldSet,Before,Remove)

expressionAnexpressionthatreturnsaPivotAxis,PivotDataAxis,PivotFilterAxis,orPivotGroupAxisobject.

FieldSetRequiredPivotFieldSetobject.Specifiesthefieldsettobeinserted.

BeforeOptionalVariant.Specifiestheindexofthefieldsetbeforewhichtheinsertedfieldsetwillbeplaced.

RemoveOptionalBoolean.Thisargumentisreservedforfutureuse,anditsvalueisalwaysTrue.Whenthefieldsetisaddedtothespecifiedaxis,itisremovedfromanyotheraxis.

ExampleThisexampleaddsafieldsettotherowaxis,dataaxis,andfilteraxisofPivotTable1.

SubAdd_Fields_To_PivotTable()DimvwViewDimptConstantsDimtotOrderCountSetptConstants=PivotTable1.ConstantsSetvwView=PivotTable1.ActiveView'AddtheShipCountryfieldtotherowaxis.vwView.RowAxis.InsertFieldSetvwView.FieldSets("ShipCountry")'AddtheOrderIdfieldtothedataaxis.vwView.DataAxis.InsertFieldSetvwView.FieldSets("OrderID")'AddtheShipViafieldtothefilteraxisvwView.FilterAxis.InsertFieldSetvwView.FieldSets("ShipVia")'Createatotalnamed"OrderCount"thatcountstheOrderIDfield.SettotOrderCount=vwView.AddTotal("OrderCount",vwView.FieldSets("OrderId").Fields("OrderId"),_ptConstants.plFunctionCount)'AddtheOrderCounttotaltothedataaxis.vwView.DataAxis.InsertTotaltotOrderCountEndSub

InsertTotalMethod

AddsaPivotTotalobjecttothePivotTotalscollection.

expression.InsertTotal(Total,Before)

expressionAnexpressionthatreturnsaPivotDataAxisobject.

TotalRequiredPivotTotalobject.Specifiesthetotaltobeinserted.

BeforeOptionalVariant.Specifiestheindexofthetotalbeforewhichtheinsertedtotalwillbeplaced.Ifyoudonotspecifythisargument,thetotalisinsertedattheendofthecollection.

RemarksIfthePivotTotalobjectiscurrentlypartofthePivotTotalscollection,theobjectisfirstremovedfromthatcollectionandthenreinsertedintoit.Thischangesthedisplayorderbecausetotalsaredisplayedintheircollectionorder.

ExampleThisexampleaddsatotalnamed"TotalBudget"thatsumsthevaluesintheBudgetfieldtoPivotTable1,thentheninsertsthetotalintothePivotTableview.

SubAdd_Total()DimvwViewDimptConstantsDimtotNewTotal

SetvwView=PivotTable1.ActiveViewSetptConstants=PivotTable1.Constants'Addanewtotalnamed"TotalBudget"tothecurrentview.SettotNewTotal=vwView.AddTotal("TotalBudget",vwView.Fieldsets("budget").Fields(0),_ptConstants.plFunctionSum)'InsertthenewlycreatedtotalintothedetailareaofthePivotTable.vwView.DataAxis.InsertTotaltotNewTotal

EndSub

ShowAll

IsButtonEnabledMethod

IsButtonEnabledmethodasitappliestotheDataPageobject.

IsButtonEnabledmethodasitappliestotheRecordNavigationControlobject.

ItemMethod

ReturnsaNameobjectfromtheNamescollection.

expression.Item(Index,IndexLocal,RefersTo)

expressionRequired.AnexpressionthatreturnsaNamesobject.

IndexOptionalVariant.Thenameornumberofthedefinednametobereturned.

IndexLocalOptionalVariant.Thenameofthedefinedname,inthelanguageoftheuser.Nonameswillbetranslatedifyouusethisargument.

RefersToOptionalVariant.Thisargumentisnotsupported.

RemarksYoumustspecifyone,andonlyone,ofthesethreearguments.

ExampleThisexampledeletesthename"SortRange"fromtheworkbook.

Spreadsheet1.ActiveWorkbook.Names("SortRange").Delete

LargeScrollMethod

Scrollsthecontentsofthewindowbypages.Thesizeofthepagesisdeterminedbythenumberofrowsandcolumnsvisibleintheactivewindow.

expression.LargeScroll(Down,Up,ToRight,ToLeft)

expressionRequired.AnexpressionthatreturnsaWindowobject.

DownOptionalVariant.Thenumberofpagestoscrollthecontentsdown.

UpOptionalVariant.Thenumberofpagestoscrollthecontentsup.

ToRightOptionalVariant.Thenumberofpagestoscrollthecontentstotheright.

ToLeftOptionalVariant.Thenumberofpagestoscrollthecontentstotheleft.

RemarksIfDownandUporToRightandToLeftarebothspecified,thecontentsofthewindowarescrolledbythedifferenceofthearguments.Forexample,ifDownis3andUpis6,thecontentsarescrolledupthreepages.

Anyoftheargumentscanbeanegativenumber.

ExampleThisexamplescrollsthecontentsoftheactivewindowofSpreadsheet1downthreepagesandtotherighttwopages.

Spreadsheet1.ActiveWindow.LargeScroll3,,2

LoadMethod

LoadsXMLchartdatafromaURLorlocalfile.ThefilemustconsistofonlychartingXML,anditcannotcontainanyleadingHTML.Thestringmustbeginwith<scriptlanguage="XML">andendwith</script>.

expression.Load(FileNameAsString)

expressionAnexpressionthatreturnsaChartSpaceobject.

FileNameRequiredString.SpecifiesthefilecontainingXMLchartdata.

ExampleThisexampleloadsthespecifiedXMLdatafile.

ChartSpace1.Load"chart.xml"

LoadTextMethod

Loadsandparsesthespecifiedtextfileintoaworksheet.Thecontentsofthetextfileareloadedintotheworksheetbeginningatthespecifiedcell.Existingcellcontentswillbeoverwritten.

expression.LoadText(File,Delimiters,ConsecutiveDelimAsOne,TextQualifier)

expressionAnexpressionthatreturnsaRangeobject.

FileRequiredString.Specifiesthenameofthetextfile.

DelimitersOptionalString.Specifiesthefielddelimiters.Thedefaultvalueisnodelimiter.

ConsecutiveDelimAsOneOptionalBoolean.Truetohaveconsecutivedelimitersconsideredasasingledelimiter.ThedefaultvalueisFalse.

TextQualifierOptionalString.Specifiesthetextqualifier.Thedefaultvalueisthedoublequotationmarkcharacter.

ExampleThisexampleinsertsatab-delimitedtextfileintotheactiveworksheetofSpreadsheet1.ThecontentsofthetextfilewillbeginincellB10.

Spreadsheet1.ActiveSheet.Range("B10").LoadText"tabfile.txt",Chr$(9)

MakeCurrentMethod

Makesthespecifiedsectionthecurrentsection.

expression.MakeCurrent(ScrollIntoView)

expressionAnexpressionthatreturnsaSectionobject.

ScrollIntoViewOptionalBoolean.SetthisargumenttoTruetoscrollthesectionintoview.ThedefaultvalueisFalse.

MergeMethod

Createsamergedcellfromthespecifiedrange.Whenyoucreateamergedcell,thevalueintheupper-leftcellinthespecifiedrangeisusedforthemergedcellvalue.Allothercellvaluesinthemergedcellareignored.

expression.Merge(Across)

expressionAnexpressionthatreturnsaRangeobject.Thismethodfailsiftherangeonlypartiallyenclosesapreviouslymergedcell.

AcrossOptionalVariant.Truetomergecellsineachrowinthespecifiedrangeasseparatemergedcells.ThedefaultvalueisFalse.

ExampleThisexamplecreatesamergedcellfromtherangeB2:C5andputsathickredborderaroundthemergedcell.

SubMerge_Cells()DimssConstantsDimrngMerged

SetssConstants=Spreadsheet1.Constants

'MergecellsB2:C5.Spreadsheet1.ActiveSheet.Range("B2:C5").Merge

'Setavariabletothemergedrange.SetrngMerged=Spreadsheet1.ActiveSheet.Range("B2").MergeArea

'Formatthemergedcell.rngMerged.Borders.Color="Red"rngMerged.Borders.Weight=ssConstants.owcLineWeightThickrngMerged.HorizontalAlignment=ssConstants.xlHAlignCenterrngMerged.VerticalAlignment=ssConstants.xlVAlignCenterEndSub

MoveMethod

Movesthesheettoanotherlocationintheworkbook.

expression.Move(Before,After)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

BeforeOptionalVariant.Thesheetbeforewhichthemovedsheetwillbeplaced.YoucannotspecifyBeforeifyouspecifyAfter.

AfterOptionalVariant.Thesheetafterwhichthemovedsheetwillbeplaced.YoucannotspecifyAfterifyouspecifyBefore.

MoveDetailLeftMethod

Scrollsthedetailareatotheleftstartingatthespecifiedcolumnmember.

expression.MoveDetailLeft(DetailLeft,DetailLeftOffset,Update)

expressionRequired.AnexpressionthatreturnsaPivotColumnMemberobject.

DetailLeftRequiredLong.Anindexnumberindicatingforthecelltouseasthebasisforscrolling.Forexample,useavalueof2tostartthescrollingatthethirdcolumninthedetailarea.

DetailLeftOffsetRequiredLong.Thenumberofpixelstoscroll.

UpdateOptionalBoolean.Determineswhetherornotthedisplayisupdated.ThedefaultvalueisTrue.

ExampleThisexamplescrollsthedetailareatotheleftby10pixelsstartingatthesecondcolumn.

SubScrollDetailColumns()

DimptDataDimpmColumnMember

SetptData=PivotTable1.ActiveData

SetpmColumnMember=ptData.ColumnAxis.Member

'Scrollthefirstcolumninthedetailarea'theleftby10pixels.pmColumnMember.MoveDetailLeft1,10

EndSub

MoveDetailTopMethod

Scrollsthethedetailareadownstartingatthespecifiedcell.

expression.MoveDetailTop(DetailTop,DetailTopOffset,Update)

expressionRequired.AnexpressionthatreturnsaPivotCellobject.

DetailTopRequiredLong.Anindexnumberindicatingthecelltouseasthebasisforscrolling.Forexample,useavalueof5tostartthescrollingatthesixthrowinthedetailarea.

DetailTopOffsetRequiredLong.Thenumberofpixelstoscroll.Use0toscrolltherecordspecifiedintheDetailTopargumenttothetopofthedetailarea.

UpdateOptionalBoolean.Determineswhetherornotthedisplayisupdated.ThedefaultvalueisTrue.

RemarksUsetheMoveDetailLeftmethodtoscrollthedetailareatotheleft.

ExampleThisexamplescrollsthefifteenthrowtothefirstrowdisplayedinthedetailarea.

SubScrollDetailArea()

DimptDataDimpmColumnMemberDimpmRowMember

SetptData=PivotTable1.ActiveData

SetpmRowMember=ptData.RowAxis.MemberSetpmColumnMember=ptData.ColumnAxis.Member

'Startingatthe15throwofthedetailarea,scroll100pixels.ptData.Cells(pmRowMember,pmColumnMember).MoveDetailTop

EndSub

MoveFirstMethod

Movestothefirstrecordinthedataaccesspagerecordset.Thismethodfailsifthecurrentrecordisthefirstrecordintherecordset.

expression.MoveFirst

expressionAnexpressionthatreturnsaDataPageobject.

MoveLastMethod

Movestothelastrecordinthedataaccesspagerecordset.Thismethodfailsifthecurrentrecordisthelastrecordintherecordset.

expression.MoveLast

expressionAnexpressionthatreturnsaDataPageobject.

MoveLeftMethod

Scrollsacolumnfieldmemberleftbythespecifiednumberofpixels,oruntilthenextrowmemberhasbeenscrolledtotheleftsideofthedisplay.

expression.MoveLeft(Left,LeftOffset,Update)

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

LeftRequiredPivotColumnMemberobject.Thecolumnmembertoscroll.

LeftOffsetRequiredLong.Thenumberofpixelstoscrollthemember.

UpdateOptionalBoolean.Determineswhetherornotthedisplayisupdated.ThedefaultvalueisTrue.

RemarksUsetheMoveToppropertytoscrollrowfieldmembers.

ExampleThisexamplescrollsthePivotTableviewtothenextcolumnmember.

SubScrolltoNextColumnMember()

DimptData

SetptConstants=PivotTable1.Constants

SetptData=PivotTable1.ActiveData

'Scrolltothenextcolumnmember.ptData.MoveLeftptData.Left,1000

EndSub

MoveNextMethod

Movestothenextrecordinthedataaccesspagerecordset.Thismethodfailsifthecurrentrecordisthelastrecordintherecordset.

expression.MoveNext

expressionAnexpressionthatreturnsaDataPageobject.

MovePreviousMethod

Movestothepreviousrecordinthedataaccesspagerecordset.Thismethodfailsifthecurrentrecordisthefirstrecordintherecordset.

expression.MovePrevious

expressionAnexpressionthatreturnsaDataPageobject.

MoveTopMethod

Scrollsarowfieldmemberupbythespecifiednumberofpixels,oruntilthenextrowmemberhasbeenscrolledtothetopofthedisplay.

expression.MoveTop(Top,TopOffset,Update)

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

TopRequiredPivotRowMemberobject.Therowmembertoscroll.

TopOffsetRequiredLong.Thenumberofpixelstoscrollthemember.

UpdateOptionalBoolean.Determineswhetherornotthedisplayisupdated.ThedefaultvalueisTrue.

RemarksUsetheMoveLeftpropertytoscrollcolumnfieldmembers.

ExampleThisexamplescrollsthePivotTableviewtothenextrowmember.

SubScrolltoNextRowMember()

DimptData

SetptConstants=PivotTable1.Constants

SetptData=PivotTable1.ActiveData

'Scrolltothenextrowmember.ptData.MoveTopptData.Top,1000

EndSub

NewRecordMethod

Addsanewrecordtothedataaccesspagerecordset.Thismethodfailsiftherecordsetcannotbeupdated.

expression.NewRecord

expressionAnexpressionthatreturnsaDataPageobject.

NzMethod

Usethismethodtoreturnzero,azero-lengthstring(""),oranotherspecifiedvaluewhenavalueisNull.Forexample,youcanusethisfunctiontoconvertaNullvaluetoanothervalueandpreventitfrompropagatingthroughanexpression.ReturnsaVariant.

expression.Nz(Value,ValueIfNull)

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ValueRequiredVariant.Thevaluetoconvert.

ValueIfNullOptionalVariant.ValuetoreturniftheValueargumentargumentisNull.Thisargumentenablesyoutoreturnavalueotherthanzeroorazero-lengthstring.

RemarksThismethodisusefulforexpressionsthatmayincludeNullvalues.Toforceanexpressiontoevaluatetoanon-NullvalueevenwhenitcontainsaNullvalue,usethethismethodtoreturnazero,azero-lengthstring,oracustomreturnvalue.

Forexample,theexpression2+varXwillalwaysreturnaNullvaluewhentheVariantvarXisNull.However,2+MSODSC.Nz(varX)returns2.

Inthenextexample,theoptionalargumentsuppliedtotheNzmethodprovidesthestringtobereturnedifvarFreightisNull.

varResult=MSODSC.Nz(varFreight,"NoFreightCharge")

OverrideDefaultElementFormattingMethod

YouusetheOverrideDefaultElementFormattingmethodtousethedrawingformatofthecurrentChChartDrawobjecttodrawachart.ReturnsNothing.

expression.OverrideDefaultElementFormatting()

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

Remarks

MostchartelementsthatgenerateaBeforeRendereventinitializethedrawingsurfacebyusingthedefaultformattingoftheChartcomponent.YoucanusetheOverrideDefaultElementFormattingmethodintheBeforeRendereventproceduretochangethedefaultpropertiesofthecurrentChChartDrawobjectpassedtotheBeforeRendereventasitsdrawObjectparameter.

ExampleThefollowingexampleusestheOverrideDefaultElementFormattingmethodtochangeapropertyoftheChChartDrawobject:

SubChartspace_BeforeRender(drawObjectAsChChartDraw,chartObjectAsObject,CancelAsByRef) OnErrorResumeNext

'Thisformatwillbeappliedonlytoalllegends. IfTypeName(chartObject)="ChLegend"Then drawObject.border.weight=5 drawObject.border.color="green" drawObject.OverrideDefaultElementFormatting EndIf 'Thisformatwillonlybeappliedtoalltitles. IfTypeName(chartObject)="ChTitle"Then drawObject.border.weight=10 drawObject.border.color="violet" drawObject.OverrideDefaultElementFormatting EndIfEndSub

SubChartspace_AfterRender(drawObjectAsChChartDraw,chartObjectAsObject) SelectCaseTypeName(chartObject) Case"ChLegend","ChTitle" 'ChartspacewillapplytheoverrideddrawObjectformattotheTitleandLegendobjects. drawObject.DrawRectanglechartObject.Left,_ chartObject.Top,chartObject.right,chartObject.bottom EndSelectEndSub

ParseTextMethod

Parsesthespecifiedtextstringandplacestheresultinthespecifiedrange.

expression.ParseText(Text,Delimiters,ConsecutiveDelimAsOne,TextQualifier)

expressionAnexpressionthatreturnsaRangeobject.

TextRequiredString.Specifiesthestringtobeparsed.

DelimitersOptionalString.Specifiesthefielddelimiters.

ConsecutiveDelimAsOneOptionalBoolean.Truetohaveconsecutivedelimitersconsideredasonedelimiter.ThedefaultvalueisFalse.

TextQualifierOptionalString.Specifiesthetextqualifier.Thedefaultvalueisthedoublequotationmarkcharacter.

ExampleThisexampleparsesthespecifiedstringintotherangestartingatcellA1.

Spreadsheet1.ActiveSheet.Range("A1").ParseText"name,address,city,state",","

ShowAll

PasteMethod

PastemethodasitappliestotheWorksheetobject.

PastemethodasitappliestotheRangeobject.

ExampleAsitappliestotheWorksheetobject.

AsitappliestotheRangeobject.

PointsToScreenPixelsXMethod

ReturnsaLongvaluethatrepresentsthenumberofpixelsfromtheleftedgeofthespreadsheet'swindowtotheleftedgethefirstcolumninthespreadsheet,plusthevaluespecifiedinthePointsargument.

expression.PointsToScreenPixelsX(Points)

expressionRequired.AnexpressionthatreturnsaWindowobject.

PointsRequiredLong.Thenumberofpixelstoaddtothismethod'sresult.

RemarksAlthoughthenameofthismethodsuggeststhatitwillconvertpointvaluestoscreenpixelvalues,itactuallyperformstheactiondescribedaboveusingonlypixelvalues.ForthePointsToScreenPixelsXmethod,thisvaluewillvarybyafixedamount(24pixels)dependingonwhetherrowheadersareturnedon.

ExampleThisexamplereturns25whenrowheadersareturnedon,andreturns1whenrowheadersareturnedoff.

SubWindow_OnLoad()

MsgBoxSpreadsheet1.ActiveWindow.PointsToScreenPixelsX(0)

EndSub

PointsToScreenPixelsYMethod

ReturnsaLongvaluethatrepresentsthenumberofpixelsfromthetopedgeofthespreadsheet'swindowtothetopedgeofthefirstrowinthespreadsheet,plusthevaluespecifiedinthePointsargument.

expression.PointsToScreenPixelsY(Points)

expressionRequired.AnexpressionthatreturnsaWindowobject.

PointsRequiredLong.Thenumberofpixelstoaddtothismethod'sresult.

RemarksAlthoughthenameofthismethodsuggeststhatitwillconvertpointvaluestoscreenpixelvalues,itactuallyperformstheactiondescribedaboveusingonlypixelvalues.ForthePointsToScreenPixelsYmethod,thisvaluewillvarydependingonwhetherthetoolbar(22pixels)andcolumnheaders(17pixels)areturnedon.

ExampleThisexamplereturns40whenboththetoolbarandcolumnheadersareturnedon,andreturns1whenthetoolbarandcolumnheadersareturnedoff.

SubWindow_OnLoad()

MsgBoxSpreadsheet1.ActiveWindow.PointsToScreenPixelsY(0)

EndSub

ShowAll

ProtectMethod

ProtectmethodasitappliestotheWorksheetobject.

ProtectmethodasitappliestotheWorkbookobject.

RemarksSettinganunsupportedargumenttoTruewillresultinanrun-timeerror.

ExampleAsitappliestotheWorksheetobject.

ShowAll

RangeFromPointMethod

RangeFromPointmethodasitappliestotheChartSpaceobject.

RangeFromPointmethodasitappliestotheWindowobject.

ExampleAsitappliestotheChartSpaceobject.

RectIntersectMethod

ReturnsaRangeobjectthatrepresentstherectangularintersectionofthespecifiedranges.ReturnsNothingifthespecifiedrangesdonotoverlap.

expression.RectIntersect(Range1,Range2)

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject

Range1RequiredRange.

Range2RequiredRange.

ExampleThisexampleboldsthecellswherethenamedrange"Range1"overlapsthenamedrange"Range2"intheactivesheetofSpreadsheet1.

SubBoldIntersection()

DimrngIntersectDimrngFirstRangeDimrngSecondRange

'Setavariabletothefirstnamedrange.SetrngFirstRange=Spreadsheet1.ActiveSheet.Range("Range1")

'Setavariabletothesecondnamedrange.SetrngSecondRange=Spreadsheet1.ActiveSheet.Range("Range2")

'Setavariabletotheintersectionofthetwonamedranges.SetrngIntersect=Spreadsheet1.RectIntersect(rngFirstRange,rngSecondRange)

'Checkwhetherthenamedrangesoverlap.IfNotrngIntersectIsNothingThen

'Boldthefontintheoverlappingportion'ofthetworanges.rngIntersect.Font.Bold=True

EndIf

EndSub

RectUnionMethod

ReturnsaRangeobjectthatrepresentsthesmallestrangeofcellsthatincludestheunionofthespecifiedranges.

expression.RectUnion(Range1,Range2)

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

Range1RequiredRange.

Range2RequiredRange.

RemarksThismethodalwaysreturnsarectangularrange.Forexample,ifyouspecifyA1:A5andF1:F10,thereturnvalueistherectangularrangeA1:F10.Also,youcannotusethismethodtocreatearangecontainingnoncontiguousareas.

ShowAll

RefreshMethod

RefreshmethodasitappliestotheXmlDataBindingobject

RefreshmethodasitappliestoallotherobjectsintheAppliesTolist.

ExampleAsitappliestotheXmlDataBindingobject.

AsitappliestotheChartSpaceobject

RefreshJetCacheMethod

Refreshesthedataaccesspage'sconnectionwithaMicrosoftAccessdatabase.

expression.RefreshJetCache()

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RemoveFieldSetMethod

Removesafieldsetfromthespecifiedaxis.

expression.RemoveFieldSet(FieldSet)

expressionAnexpressionthatreturnsaPivotDataAxis,PivotFilterAxis,orPivotGroupAxisobject.

FieldSetRequiredVariant.Specifiesthefieldsettoberemoved.CanbeaPivotFieldSetobject,afieldsetname,orafieldsetindexnumber.

ExampleThisexampleremovestheShipViafieldfromthefilteraxisinPivotTable1.

PivotTable1.ActiveView.FilterAxis.RemoveFieldSet"ShipVia"

RemoveTotalMethod

Removesatotalfromthespecifieddataaxis.

expression.RemoveTotal(Total)

expressionAnexpressionthatreturnsaPivotDataAxisobject.

TotalRequiredVariant.Specifiesthetotaltoberemoved.CanbeaPivotTotalobject,atotal’sname,oratotal’sindexnumber.

ExampleThisexampleremovestheOrderCounttotalfromthecurrentviewinPivotTable1.

PivotTable1.ActiveView.DataAxis.RemoveTotal"OrderCount"

RepaintMethod

Forcesaredrawofthespecifiedobject.

expression.Repaint

expressionRequired.AnexpressionthatreturnsaChartSpaceorSpreadsheetobject.

RequeryMethod

Executesthequerythatreturnedtherecordsetandallrelatedrecordsetsforthespecifiedobject.

expression.Requery

expressionAnexpressionthatreturnsaDataPageobject.

ResetMethod

ResetsthespecifiedHeadingobject.Usethismethodtoresetaspecificroworcolumnheading.UsetheResetHeadingsmethodifyouwanttoresetallrowandcolumnheadingsinawindowtotheirdefaultvalues.

expression.Reset

expressionRequired.AnexpressionthatreturnsaHeadingobject.

ExampleThisexampleresetsthecaptionofcolumnDintheactivewindowofSpreadsheet1toitsdefaultvalue.

Spreadsheet1.ActiveWindow.ColumnHeadings(4).Reset

ResetColorsMethod

Resetsthecolorpaletteofthespecifiedworkbooktothedefaultcolors.

expression.ResetColors

expressionRequired.AnexpressionthatreturnsaWorkbookobject.

ExampleThefollowingexampleresetsthecolorpaletteoftheworkbookthatisopeninSpreadsheet1backtoitsdefaultsetting.

Spreadsheet1.ActiveWorkbook.ResetColors

ResetHeadingsMethod

Resetstherowandcolumnsheadingsofthespecifiedwindowtotheirdefaultvalues.UsetheResetmethodinsteadifyouwanttoresetspecificrowandcolumnheadings.

expression.ResetHeadings

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThefollowingexampleresetstherowandcolumnheadingsoftheactivewindowinSpreadsheet1totheirdefaultvalues.

Spreadsheet1.ActiveWindow.ResetHeadings

RotateClockwiseMethod

Rotatesallseriesinthespecifiedchartclockwisein90-degreeincrements.

expression.RotateClockwise

expressionAnexpressionthatreturnsaChPlotAreaobject.

ExampleThisexamplerotatesallseriesinthespecifiedchartclockwise90degrees.

ChartSpace1.Charts(0).PlotArea.RotateClockwise

RotateCounterClockwiseMethod

Rotatesallseriesinthespecifiedchartcounterclockwisein90-degreeincrements.

expression.RotateCounterClockwise

expressionAnexpressionthatreturnsaChPlotAreaobject.

ExampleThisexamplerotatesallseriesinthespecifiedchartcounterclockwise90degrees.

ChartSpace1.Charts(0).PlotArea.RotateCounterClockwise

SaveMethod

Savesthecurrentrecordtothedatabaseassociatedwiththespecifieddataaccesspage.

expression.Save

expressionAnexpressionthatreturnsaDataPageobject.

ScrollIntoViewMethod

Scrollsthedocumentwindowsothatthecontentsofaspecifiedrectangularareaaredisplayedineithertheupper-leftorlower-rightcornerofthedocumentwindoworpane(dependingonthevalueoftheStartargument).

expression.ScrollIntoView(Left,Top,Width,Height,Start)

expressionRequired.AnexpressionthatreturnsaWindowobject.

LeftRequiredLong.Thehorizontalpositionoftherectangle(inpoints)fromtheleftedgeofthedocumentwindoworpane.

TopRequiredLong.Theverticalpositionoftherectangle(inpoints)fromthetopofthedocumentwindoworpane.

WidthRequiredLong.Thewidthoftherectangleinpoints.

HeightRequiredLong.Theheightoftherectangleinpoints.

StartOptionalVariant.Truetohavetheupper-leftcorneroftherectangleappearintheupper-leftcornerofthedocumentwindoworpane.Falsetohavethelower-rightcorneroftherectangleappearinthelower-rightcornerofthedocumentwindoworpane.ThedefaultvalueisTrue.

RemarksTheStartargumentisusefulfororientingthescreendisplaywhentherectangleislargerthanthedocumentwindow.

ExampleThisexampledefinesa100-by-200-pixelrectangleintheactivedocumentwindow,positioned20pixelsfromthetopofthewindowand50pixelsfromtheleftedgeofthewindow.Theexamplethenscrollsthedocumentupandtotheleftsothattheupper-leftcorneroftherectangleisalignedwiththeupper-leftcornerofthewindow.

Spreadsheet1.ActiveWindow.ScrollIntoView50,20,100,200

ShowAll

SelectMethod

SelectmethodasitappliestotheChartSpace,ChAxis,ChCategoryLabel,ChChart,ChChartField,ChDataLabel,ChDataLabels,ChErrorBars,ChGridlines,ChLegend,ChLegendEntry,ChPlotArea,ChPoint,ChSeries,ChSurface,ChTitle,ChTrendline,Range,Sheets,Worksheet,andWorksheetsobjects.

SelectmethodasitappliestothePivotTableobject.

ExampleThisexampleselectsthecellthatisonecolumntotherightofandinthesamerowastheactivecell.

Spreadsheet1.ActiveCell.Offset(0,1).Select

ShowAll

Select2Method

YouusetheSelect2methodoftheChPointobjecttoworkwithanobjectinthecollectionofcurrentlyselectedobjects.ReturnsNothing.

expression.Select2(selmode)

expressionRequired.AnexpressionthatreturnsaChPointobject.

selmodeOptionalChartSelectMode.

Remarks

TheSelect2methodissimilartotheSelectmethodoftheChPointobject,excepttheSelect2methodhasanoptionalselmodeparameter.Theprimaryselectionistypicallythefirstobjectselected.Otherselectedobjectsaresecondaryselections.OnlytheprimaryselectionisrecognizedbyChartcomponentmethodsandpropertiesthatworkwiththecurrentselection.

ShowAll

SetDataMethod

Setsdataforthespecifiedchartobject.

expression.SetData(Dimension,DataSourceIndex,DataReference)

expressionAnexpressionthatreturnsaChChart,ChErrorBarsChSeries,orChartSpaceobject.

DimensionRequiredChartDimensionsEnumconstant.Specifiesthedatadimensiontobeset.

DataSourceIndexRequiredLong.CanbeaChartSpecialDataSourcesEnumconstant.

DataReferenceOptionalVariant.ForChChartandChSeriesobjects,thisargumentspecifiesthedatareferenceasaMicrosoftExcel-stylerangereference("A1:D4",forexample),orarow-setcolumnname.WhentheDataSourceIndexargumentissettochDataLiteral,youcansetDataReferencetoaone-dimensionalarrayoracomma-delimitedlist.ForChErrorBarsobjects,thisargumentspecifiesanarrayofDoubleorStringvaluesyoucanuseforerror-barvalues.Notethatyoucanusethisargumentonlywithcustomerrorbars(theerror-barTypepropertymustbesettochErrorBarTypeCustom).

RemarksAlternatively,youcanspecifyaChartErrorBarCustomValuesEnumconstantfortheDimensionargumenttospecifythevaluestouseforerrorbars.

Youcanbindacharttoonlyonedatasource.Forexample,ifyouhavetwochartsinaChartSpace,youcannotbindthemtodifferentdatasources.However,youcanbindachartordataseriestoasetofliteraldataoncethechartorChartSpacehasbeenboundtoanexternaldatasource.

WhenbindingtoanOLAPdatasource,theDataReferenceargumentcanbindtoafieldset,butnotafield.YoucanpassanarrayoffieldstotheDataReferenceargumenttobindtoaspecificfieldorfieldswhenconnectedtoanOLAPdatasource.

ExampleThisexamplecreatesachartusingliteraldataarrays.

SubBindChartToArrays()

DimasSeriesNames(1)DimasCategories(7)DimaiValues(7)DimchConstantsDimchtNewChart

asSeriesNames(0)="SatisfactionData"

asCategories(0)="VeryGood"asCategories(1)="Good"asCategories(2)="N/A"asCategories(3)="Average"asCategories(4)="NoResponse"asCategories(5)="Poor"asCategories(6)="VeryPoor"

aiValues(0)=10aiValues(1)=22aiValues(2)=6aiValues(3)=31aiValues(4)=5aiValues(5)=14aiValues(6)=12

SetchConstants=ChartSpace1.Constants

'AddanewcharttoChartspace1.SetchtNewChart=ChartSpace1.Charts.Add

'Specifythatthechartisacolumnchart.chtNewChart.Type=chConstants.chChartTypeColumnClustered

'Bindthecharttothearrays.chtNewChart.SetDatachConstants.chDimSeriesNames,chConstants.chDataLiteral,asSeriesNameschtNewChart.SetDatachConstants.chDimCategories,chConstants.chDataLiteral,asCategorieschtNewChart.SeriesCollection(0).SetDatachConstants.chDimValues,chConstants.chDataLiteral,aiValues

EndSub

Thisexamplecreatesachartthatisboundtoaspreadsheet.TheseriesnameisincellB1,thecategorynamesareincellsA2:A28,andthevaluesareincellsB2:B28.

SubBindToSpreadsheet()DimchConstantsDimchtChart1

SetchConstants=ChartSpace1.Constants

'SetthedatasourceofChartSpace1toSpreadsheet1.SetChartSpace1.DataSource=Spreadsheet1

'SetavariabletoanewchartinChartspace1.SetchtChart1=ChartSpace1.Charts.Add

'Setthecharttype.chtChart1.Type=chConstants.chChartTypeLineMarkers

'BindtheseriesnametocellB1inthefirstsheetofSpreadsheet1.chtChart1.SetDatachConstants.chDimSeriesNames,chConstants.chDataBound,"B1"

'BindthecategoryaxistocellA2:A28inthefirstsheetofSpreadsheet1.chtChart1.SetDatachConstants.chDimCategories,chConstants.chDataBound,"A2:A28"

'BindthevaluesofthedataseriestocellsB2:B28inthefirstsheetofSpreadsheet1.chtChart1.SeriesCollection(0).SetDatachConstants.chDimValues,chConstants.chDataBound,"B2:B28"

EndSub

ThefollowingexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreated.Thesmallervaluesaredisplayedinwhite,thenlargervaluesaredisplayedinalightshadeofblue,andfinallythelargestvaluesinthechartaredisplayedindarkblue.

SubWindow_Onload()

DimserSeries1DimsegSegment1DimchConstants

SetchConstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;PersistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=ServerName;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields

'intheOrderdetailstable.ChartSpace1.SetDatachConstants.chDimCategories,chConstants.chDataBound,"ProductID"ChartSpace1.SetDatachConstants.chDimValues,chConstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachConstants.chDimFormatValues,chConstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.SetsegSegment1=serSeries1.FormatMap.Segments.Add

'Specifythatthedivisionsinformattingbecreatedautomatically.segSegment1.HasAutoDivisions=True

'Measurethesegmentboundariesbaseduponapercentage.segSegment1.Begin.ValueType=chConstants.chBoundaryValuePercentsegSegment1.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto100%.segSegment1.Begin.Value=0segSegment1.End.Value=1

'Formattheinteriorofthematchingvalues.segSegment1.Begin.Interior.Color="White"segSegment1.End.Interior.Color="Blue"

EndSub

SetExtentMethod

YouusetheSetExtentmethodtotospecifytheviewextentoftheChScrollViewobjectofaChartcomponent.ReturnsNothing.

expression.SetExtent(HorizontalExtent,VerticalExtent)

expressionRequired.AnexpressionthatreturnsaChScrollViewobject.

HorizontalExtentRequiredLong.

VerticalExtentRequiredLong.

Remarks

UsingthismethodtospecifythecurrentscrollviewpositionhasthesameeffectassettingtheHorizontalExtentandVerticalExtentpropertiesindividually.IfyouusetheSetExtentmethodratherthantheHorizontalExtentandVerticalExtentpropertiesindividually,however,lessrepaintingwilloccur.

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotareaanditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechartandtheremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.ForinformationonhowthevaluesofthepropertiesoftheChScrollViewobjectrelatetoeachother,seetheChScrollViewobjecttopic.

TheVerticalPositionandHorizontalPositionpropertiesdescribetheupper-leftcornerofthevisibleplotarea.TheVerticalExtentandHorizontalExtentpropertiesdescribethelower-rightcornerofthevisibleplotarea.Becauseyouwillfrequentlyworkwiththesepropertiestogether,youcanuseSetPositionmethodtospecifytheupper-leftcornerofthevisibleplotareaandtheSetExtentmethodtospecifythelower-rightcorner.

ExampleThefollowingexampleusestheSetExtentmethodtosettheverticalandhorizontalextentofthescrollviewofacharttozoomby200percent.

DimlngHMaxDimlngVMax

lngHMax=ChartSpace1.Charts(0).ScrollView.HorizontalExtentMax*2lngVMax=ChartSpace1.Charts(0).ScrollView.VerticalExtentMax*2

ChartSpace1.Charts(0).ScrollView.SetExtentlngHMax,lngVMax

ShowAll

SetOneColorGradientMethod

FillsthespecifiedChInteriorobjectwithaone-colorgradient.

expression.SetOneColorGradient(GradientStyle,GradientVariant,GradientDegree,Color)

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

GradientStyleRequiredChartGradientStyleEnum.Thegradientstyle.

GradientVariantRequiredChartGradientVariantEnum.Thegradientvariant.

GradientDegreeRequiredDouble.Thegradientdegree.Canbeavaluefrom0.0(dark)through1.0(light).

ColorOptionalVariant.Theforegroundcolorforthegradient.YoucanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(forexample,redisRGB(255,0,0)).Ifthisargumentisomitted,thentheColorpropertyisused.

ExampleThisexamplesetstheinteriorfillofthefirsttwoseriesandtheplotareaofthefirstchartinChartSpace1.

SubFormatInteriorColors()

DimchConstantsDimserSeries1DimserSeries2

SetchConstants=ChartSpace1.Constants

SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)SetserSeries2=ChartSpace1.Charts(0).SeriesCollection(1)

'Settheinteriorfillofthefirstseriestoaone-colorgradient.serSeries1.Interior.SetOneColorGradientchConstants.chGradientDiagonalDown,_chConstants.chGradientVariantCenter,0.2,"Blue"

'Settheinteriorfillofthesecondseriestoapresetgradient.serSeries2.Interior.SetPresetGradientchConstants.chGradientFromCenter,_chConstants.chGradientVariantEnd,chConstants.chGradientDaybreak

'Settheinteriorfilloftheplotareatoapattern.ChartSpace1.Charts(0).PlotArea.Interior.SetPatternedchConstants.chPattern10Percent,_"Yellow","Blue"

EndSub

ShowAll

SetPatternedMethod

FillsthespecifiedChInteriorobjectwithapresetpattern.

expression.SetPatterned(patternType,Color,BackColor)

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

patternTypeRequiredChartPatternTypeEnum.Thepatternstyle.

ColorOptionalVariant.Theforegroundcolorforthepattern.YoucanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(forexample,redisRGB(255,0,0)).Ifthisargumentisomitted,thentheColorpropertyisused.

BackColorOptionalVariant.Thebackgroundcolorforthepattern.YoucanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(forexample,redisRGB(255,0,0)).Ifthisargumentisomitted,thentheBackColorpropertyisused.

ExampleThisexamplesetstheinteriorfillofthefirsttwoseriesandtheplotareaofthefirstchartinChartSpace1.

SubFormat_Interior_Colors()

DimchConstantsDimserSeries1DimserSeries2

SetchConstants=ChartSpace1.Constants

SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)SetserSeries2=ChartSpace1.Charts(0).SeriesCollection(1)

'Settheinteriorfillofthefirstseriestoaone-colorgradient.serSeries1.Interior.SetOneColorGradientchConstants.chGradientDiagonalDown,_chConstants.chGradientVariantCenter,0.2,"Blue"

'Settheinteriorfillofthesecondseriestoapresetgradient.serSeries2.Interior.SetPresetGradientchConstants.chGradientFromCenter,_chConstants.chGradientVariantEnd,chConstants.chGradientDaybreak

'Settheinteriorfilloftheplotareatoapattern.ChartSpace1.Charts(0).PlotArea.Interior.SetPatternedchConstants.chPattern10Percent,_"Yellow","Blue"

EndSub

SetPositionMethod

YouusetheSetPositionmethodtotospecifythecurrentviewpositionoftheChScrollViewobjectofaChartcomponent.ReturnsNothing.

expression.SetPosition(HorizontalPosition,VerticalPosition)

expressionRequired.AnexpressionthatreturnsaChScrollViewobject.

HorizontalPositionRequiredLong.

VerticalPositionRequiredLong.

Remarks

UsingthismethodtospecifythecurrentscrollviewpositionhasthesameeffectassettingtheHorizontalPositionandVerticalPositionpropertiesindividually.IfyouusetheSetPositionmethodratherthantheHorizontalPositionandVerticalPositionpropertiesindividually,however,lessrepaintingwilloccur.

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotarea,anditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechart;theremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.ForinformationonhowthevaluesofthepropertiesoftheChScrollViewobjectrelatetoeachother,seetheChScrollViewobjecttopic.

TheVerticalPositionandHorizontalPositionpropertiesdescribetheupper-leftcornerofthevisibleplotarea.TheVerticalExtentandHorizontalExtentpropertiesdescribethelower-rightcornerofthevisibleplotarea.Becauseyouwillfrequentlyworkwiththesepropertiestogether,youcanuseSetPositionmethodtospecifytheupper-leftcornerofthevisibleplotareaandtheSetExtentmethodtospecifythelower-rightcorner.

ExampleThisexampleshowsthelower-leftcornerofazoomedchartinthelower-leftcornerofthevisibleplotarea.

DimlngVEDimlngHEDimlngVEMDimlngHEMDimobjScrollView

SetobjScrollView=ChartSpace1.Charts(0).ScrollViewlngVE=objScrollView.VerticalExtentlngHE=objScrollView.HorizontalExtentlngVEM=objScrollView.VerticalExtentMaxlngHEM=objScrollView.HorizontalExtentMax

'Forzoomedchart,displaylowerleftcornerofvirtualplotareain'thelowerleftcornerofthevisibleplotarea.If(lngVE<>lngVEM)Or(lngHE<>lngHEM)ThenobjScrollView.SetPosition0,objScrollView.VerticalPosition+(lngVEM-lngVE)EndIf

ShowAll

SetPresetGradientMethod

FillsthespecifiedChInteriorobjectwithapresetgradientstyle.

expression.SetPresetGradient(GradientStyle,gradientVarient,gradientPreset)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

GradientStyleRequiredChartGradientStyleEnum.Thegradientstyle.

gradientVarientRequiredChartGradientVariantEnum.Thegradientvariant.

gradientPresetRequiredChartPresetGradientTypeEnum.Thegradientstyleusedtofillthespecifiedobject.

ExampleThisexamplesetstheinteriorfillofthefirsttwoseriesandtheplotareaofthefirstchartinChartSpace1.

SubFormat_Interior_Colors()

DimchConstantsDimserSeries1DimserSeries2

SetchConstants=ChartSpace1.Constants

SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)SetserSeries2=ChartSpace1.Charts(0).SeriesCollection(1)

'Settheinteriorfillofthefirstseriestoaone-colorgradient.serSeries1.Interior.SetOneColorGradientchConstants.chGradientDiagonalDown,_chConstants.chGradientVariantCenter,0.2,"Blue"

'Settheinteriorfillofthesecondseriestoapresetgradient.serSeries2.Interior.SetPresetGradientchConstants.chGradientFromCenter,_chConstants.chGradientVariantEnd,chConstants.chGradientDaybreak

'Settheinteriorfilloftheplotareatoapattern.ChartSpace1.Charts(0).PlotArea.Interior.SetPatternedchConstants.chPattern10Percent,_"Yellow","Blue"

EndSub

SetRootRecordsetMethod

SetstherootrecordsetforthespecifiedDataSourceControlobject.Usethismethodtochangetherecordsettowhichadataaccesspageisbound.

expression.SetRootRecordset(RecordsetName,Recordset)

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RecordsetNameRequiredString.Thenametouseforthenewrecordset.IftheDataSourcecontrolcontainsarecordsetofthisname,itwillbereplaced.

RecordsetRequiredRecordsetobject.TheADOrecordset.

RemarksThismethodsupportsconnectingtoanyADOrecordset.

ExampleThisexamplechangestherootrecordsetusedbythedatasourcecontrol.

SubChangeRootRecordset()DimrstCategoriesDimstrShapeTextDimstrConnectionString

strShapeText=MSODSC.RootRecordsetDefs(0).ShapeText

strConnectionString="Provider=MSDataShape.1;PersistSecurityInfo=True;DataSource"&"=sqlsvr;IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&"DataProvider=SQLOLEDB.1"

SetrstCategories=CreateObject("ADODB.Recordset")

rstCategories.OpenstrShapeText,strConnectionString,1,3

MSODSC.SetRootRecordset"Categories",rstCategories

EndSub

SetSolidMethod

FillsthespecifiedChInteriorobjectwithasolidcolor.Usethismethodtoconvertagradient,textured,patterned,orbackgroundfillbacktoasolidfill.

expression.SetSolid(Color)

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

ColorOptionalVariant.ThecolorforthespecifiedChInteriorobject.YoucanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(forexample,redisRGB(255,0,0)).

ExampleThisexamplesetstheinteriorfillofthefirsttwoseriesandtheplotareaofthefirstchartinChartSpace1.

SubFormat_Interior_Fills()

DimchConstantsDimserSeries1DimserSeries2

SetchConstants=ChartSpace1.Constants

SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)SetserSeries2=ChartSpace1.Charts(0).SeriesCollection(1)

'Settheinteriorfillofthefirstseriestoatwo-colorgradient.serSeries1.Interior.SetTwoColorGradientchConstants.chGradientDiagonalDown,_chConstants.chGradientVariantCenter,"Blue","Silver"

'Settheinteriorfillofthesecondseriestoasolidcolor.serSeries2.Interior.SetSolid"Purple"

'Settheinteriorfilloftheplotareatoapresettexture.ChartSpace1.Charts(0).PlotArea.Interior.SetTextured_chConstants.chTextureParchment,chConstants.chTile

EndSub

SetSpreadsheetDataMethod

BindsthespecifiedchartorchartspacetoarangeofcellsononaworksheetintheSpreadsheetComponent.ThechartmustalreadybeboundtoarangeofcellsintheSpreadsheetComponentbeforeyoucallthismethod.

expression.SetSpreadsheetData(DataReference,SeriesByRows)

expressionRequired.AnexpressionthatreturnsaChartSpaceorChChartobject.

DataReferenceRequiredString.Areferencetotherangeofcellstobindto.Thiscanbeintheformofacellreference(A1:D5),oradefinedname.

SeriesByRowsOptionalBoolean.Specifieswhetherornoteachrowrepresentsadataseries.SetthispropertytoFalseifeachcolumnrepresentsadataseries.

ExampleThisexamplebindsChartSpace1tocellsA1:F25inthefirstsheetofSpreadsheet1.

ChartSpace1.SetSpreadsheetData"Sheet1!A1:F25",False

ShowAll

SetTexturedMethod

FillsthespecifiedChInteriorobjectwithanimageorapresettexture.

expression.SetTextured(textureFile,TextureFormat,stackUnit,TexturePlacement)

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

textureFileRequiredVariant.Theimageusedtofilltheinterioroftheobject.YoucanspecifyaURLthatpointstoanimagefileoraChartPresetTextureEnumconstant.

TextureFormatOptionalChartTextureFormatEnum.DetermineshowthepictureisdisplayedwithinthespecifiedChInteriorobject.

stackUnitOptionalDouble.SpecifieshowthepictureisstackedandscaledwhentheTextureFormatargumentissettochStackScale.

TexturePlacementOptionalChartTexturePlacementEnum.AffectswherethepictureisdisplayedwithinthespecifiedChInteriorobject.Thissettingonlyaffects3-Dcharts.

ExampleThisexamplesetstheinteriorfillofthefirsttwoseriesandtheplotareaofthefirstchartinChartSpace1.

SubFormat_Interior_Fills()

DimchConstantsDimserSeries1DimserSeries2

SetchConstants=ChartSpace1.Constants

SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)SetserSeries2=ChartSpace1.Charts(0).SeriesCollection(1)

'Settheinteriorfillofthefirstseriestoatwo-colorgradient.serSeries1.Interior.SetTwoColorGradientchConstants.chGradientDiagonalDown,_chConstants.chGradientVariantCenter,"Blue","Silver"

'Settheinteriorfillofthesecondseriestoasolidcolor.serSeries2.Interior.SetSolid"Purple"

'Settheinteriorfilloftheplotareatoapresettexture.ChartSpace1.Charts(0).PlotArea.Interior.SetTextured_chConstants.chTextureParchment,chConstants.chTile

EndSub

ShowAll

SetTwoColorGradientMethod

FillsthespecifiedChInteriorobjectwithatwo-colorgradient.

expression.SetTwoColorGradient(GradientStyle,GradientVariant,Color,BackColor)

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

GradientStyleRequiredChartGradientStyleEnum.Thegradientstyle.

GradientVariantRequiredChartGradientVariantEnum.Thegradientvariant.IfGradientStyleischGradientFromCenter,theGradientVariantargumentcanonlybechGradientVariantStartorchGradientVariantEnd.

ColorOptionalVariant.Theforegroundcolorofthegradient.YoucanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(forexample,redisRGB(255,0,0)).Ifomitted,theColorpropertyisusedtodeterminetheforegroundcolor.

BackColorOptionalVariant.Thebackgroundcolorofthegradient.YoucanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(forexample,redisRGB(255,0,0)).Ifomitted,theBackColorpropertyisusedtodeterminetheforegroundcolor.

ExampleThisexamplesetstheinteriorfillofthefirsttwoseriesandtheplotareaofthefirstchartinChartSpace1.

SubFormat_Interior_Fills()

DimchConstantsDimserSeries1DimserSeries2

SetchConstants=ChartSpace1.Constants

SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)SetserSeries2=ChartSpace1.Charts(0).SeriesCollection(1)

'Settheinteriorfillofthefirstseriestoatwo-colorgradient.serSeries1.Interior.SetTwoColorGradientchConstants.chGradientDiagonalDown,_chConstants.chGradientVariantCenter,"Blue","Silver"

'Settheinteriorfillofthesecondseriestoasolidcolor.serSeries2.Interior.SetSolid"Purple"

'Settheinteriorfilloftheplotareatoapresettexture.ChartSpace1.Charts(0).PlotArea.Interior.SetTextured_chConstants.chTextureParchment,chConstants.chTile

EndSub

ShowMethod

Scrollsthespreadsheetwindowtomovethespecifiedrangeintoview.

expression.Show

expressionAnexpressionthatreturnsaRangeobject.

RemarksIfyouspecifyarangethatisnotontheactiveworksheet,thismethodwillnotactivatethatworksheet.However,thespecifiedrangewillbevisiblewhenyouactivatethatworksheet.Forexample,ifSheet1iscurrentlyactiveandyouusethismethodwithcellA500onSheet2,Sheet1remainsactive.CellA500willbeactiveifyouimmediatelyactivateSheet2,eithermanuallyorbyusingtheActivatemethodoftheWorksheetobject.

ExampleThisexamplescrollsthespreadsheetuntilcellP75isvisible.

Spreadsheet1.ActiveSheet.Range("p75").Show

ShowAboutMethod

DisplaystheAboutMicrosoftOfficeWebComponentsdialogbox.

expression.ShowAbout

expressionRequired.AnexpressionthatreturnsaSpreadsheetorPivotTableobject.

ShowAllDataMethod

MakesallfilteredrowsvisibleonthespecifiedworksheetandsetsallfilterstoShowAll.

expression.ShowAllData

expressionAnexpressionthatreturnsaWorksheetobject.

ExampleThisexamplemakesallfilteredrowsvisibleontheactiveworksheetandsetsallfilterstoShowAll.

Spreadsheet1.ActiveSheet.ShowAllData

ShowContextMenuMethod

Displaysacustomizedcontextmenuatthespecifiedscreencoordinates.

expression.ShowContextMenu(x,y,Menu)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

xRequiredLong.Representsthex-coordinatewherethecontextmenuistoappear.

yRequiredLong.Representsthey-coordinatewherethecontextmenuistoappear.

MenuRequiredVariant.Thearraythatcontainsthemenuitemstodisplay.

ExampleThisexampledisplaysacontextmenu.

SubShowMenu()

DimcmContextMenu(4)DimcmClearSubMenu(2)

cmClearSubMenu(0)=Array("&All","ClearAll")cmClearSubMenu(1)=Array("&Formats","ClearFormats")cmClearSubMenu(2)=Array("&Values","ClearValues")

cmContextMenu(0)=Array("Cu&t","owc2")cmContextMenu(1)=Array("&Copy","owc3")cmContextMenu(2)=Array("&Paste","owc4")cmContextMenu(3)=EmptycmContextMenu(4)=Array("Clea&r",cmClearSubMenu)

Spreadsheet1.ShowContextMenu10,40,cmContextMenu

EndSub

ShowDetailsMethod

Expandsthedetailscellsforthespecifiedobject.IfthespecifiedobjectisaPivotDataobject,alldetailcellsareexpanded.IfthespecifiedobjectisaPivotRowMemberobject,thenalldetailscellsinthatrowareexpanded.IfthespecifiedobjectisaPivotColumnMemberobject,thenalldetailscellsinthatcolumnareexpanded.

expression.ShowDetails

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampleexpandsallofthedetailcellsinPivotTable1.

PivotTable1.ActiveData.ShowDetails

ShowAll

ShowHelpMethod

ShowHelpmethodasitappliestotheChartSpaceobject.

ShowHelpmethodasitappliestothePivotTableandSpreadsheetobjects.

SmallScrollMethod

Scrollsthecontentsofthewindowbyrowsorcolumns.

expression.SmallScroll(Down,Up,ToRight,ToLeft)

expressionRequired.AnexpressionthatreturnsaWindowobject.

DownOptionalVariant.Thenumberofrowstoscrollthecontentsdown.

UpOptionalVariant.Thenumberofrowstoscrollthecontentsup.

ToRightOptionalVariant.Thenumberofcolumnstoscrollthecontentstotheright.

ToLeftOptionalVariant.Thenumberofcolumnstoscrollthecontentstotheleft.

RemarksIfDownandUporToLeftandToRightarebothspecified,thecontentsofthewindowarescrolledbythedifferenceofthearguments.Forexample,ifDownis3andUpis6,thethecontentsarescrolledupthreerows.

Anyoftheseargumentscanbeanegativenumber.

ExampleThisexamplescrollsthecontentsoftheactivewindowofSpreadsheet1downthreerows.

Spreadsheet1.ActiveWindow.SmallScroll3

ShowAll

SortMethod

Sortsarangeor,ifthespecifiedrangecontainsonlyonecell,thecurrentregion

expression.Sort(ColumnKey,Order,Header)

expressionAnexpressionthatreturnsaRangeobject.

ColumnKeyOptionalLong.Thenumberofthefirstsortcolumn.Thedefaultvalueis1.

OrderOptionalXlSortOrder.Thesortorder.

HeaderOptionalXlYesNoGuess.Determineswhetherthefirstrowcontainsheaders.

ExampleThisexamplesortstherangeA1:F10indescendingorderbasedoncolumnB.

SubSortData()DimssConstants

SetssConstants=Spreadsheet1.Constants

'SortRangeA1:F10oncolumnBindescendingorderandspecifythat'row1containsheadings.Spreadsheet1.ActiveSheetRange("A1:F10").Sort2,_ssConstants.xlDescending,ssConstants.xlYesEndSub

SortAscendingMethod

Sortsafieldonadataaccesspageinascendingorder.

expression.SortAscending

expressionRequired.AnexpressionthatreturnsaDataPageobject.

RemarksThismethodreliesuponthecurrentselectiononthedataaccesspagetodeterminethefieldtosortby.Therefore,youmustsetthefocustothefieldtosortby,whentheprocedurecontainingthismethodisinvokedbyacontrolonthedataaccesspage,suchasacommandbutton.

ExampleThisexamplesortstheProductNamefieldinascendingorder.

SubSortProductNameAscending()

'SetfocustothecontrolfortheProductNamefield.MSODSC.Datapages(0).FirstSection.HTMLContainer.Children("ProductName").Focus

'Sortthefieldindescendingorder.MSODSC.DataPages(0).SortAscending

EndSub

SortDescendingMethod

Sortsafieldonadataaccesspageindescendingorder.

expression.SortDescending

expressionRequired.AnexpressionthatreturnsaDataPageobject.

RemarksThismethodreliesuponthecurrentselectiononthedataaccesspagetodeterminethefieldtosortby.Therefore,youmustsetthefocustothefieldtosortby,whentheprocedurecontainingthismethodisinvokedbyacontrolonthedataaccesspage,suchasacommandbutton.

ExampleThisexamplesortstheProductNamefieldindescendingorder.

SubSortProductNameDescending()

'SetfocustothecontrolfortheProductNamefield.MSODSC.Datapages(0).FirstSection.HTMLContainer.Children("ProductName").Focus

'Sortthefieldindescendingorder.MSODSC.DataPages(0).SortDescending

EndSub

ShowAll

StartEditMethod

Placestheactivedetailcellintoeditmode.

expression.StartEdit(InitialValue,ArrowMode,CaretPosition)

expressionRequired.AnexpressionthatreturnsoneoftheaPivotTableobject.

InitialValueOptionalVariant.Specifiestheinitialvaluetousewheneditingthecell.Thecurrentvalueisusedifyoudonotspecifyavalueforthisargument.

ArrowModeOptionalPivotArrowModeEnum.Specifieshowtheleftandrightarrowsfunctionwhiletheuserisineditmode.

CaretPositionOptionalPivotCaretPositionEnum.Specifiesthepositionoftheinsertionpointwithinthecell.

RemarksThismethodwillresultinarun-timeerrorifthecurrentselectionisnotadetailcell,orifthecurrentdataisnoteditable.

TextHeightMethod

CalculatesandreturnsaVariantthatrepresentsthewidthofthespecifiedtextinpixels,basedonthecurrentfontsetting.

expression.TextHeight(Text)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

TextRequiredString.Thetextwhosesizeyouwanttocalculate.

TextWidthMethod

CalculatesandreturnsaVariantthatrepresentsthewidthofthespecifiedtextinpixels,basedonthecurrentfontsetting.

expression.TextWidth(Text)

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

TextRequiredString.Thetextwhosesizeyouwanttocalculate.

ToggleFilterMethod

Togglesthestateofthecurrentfilterthathasbeenappliedtothedataaccesspage.Ifthefilterisactive,callingthismethoddeactivatesthefilter.Callingthismethodasecondtimereappliesthefilter.

expression.ToggleFilter

expressionRequired.AnexpressionthatreturnsaDataPageobject.

ExampleThisexampletogglesthefilteronthefirstdataaccesspageinthedatasourcecontrolnamedMSODSC.

MSODSC.DataPages(0).ToggleFilter

UndoMethod

FortheChartSpaceandSpreadsheetobjects,undoesthelastsingleactionorthelastmacroblocksurroundedbyBeginUndoandEndUndomethodcalls.

FortheDataPageobject,restoresthedataaccesspagetotheconditionbeforetherecordsetwaseditediftheeditshavenotbeensaved.

expression.Undo

expressionAnexpressionthatreturnsaChartSpace,DataPage,orSpreadsheetobject.

ExampleThisexampleundoesthelastactionordisplaysamessageboxifthisactioncannotbeundone.

IfSpreadsheet1.CanUndoThenSpreadsheet1.UndoElseMsgBox"can'tundolastaction"EndIf

UngroupMethod

Movesthespecifiedseriesintoanewlayer.

expression.Ungroup(UseNewScaling)

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

UseNewScalingOptionalBoolean.SetthisargumenttoTruetospecifythattheseriesusesadifferentscalingthanthepreviouslayer.ThedefaultvalueisFalse.

RemarksWhenyoumoveaseriesintoanewlayer,youcanassigntheseriestoanaxisthatisbasedonadifferentvaluescale.

ExampleThisexamplecreatesacombinationchartbasedonliteraldata.Thefirstdataseriesisplottedasaline.Theseconddataseriesisplottedascolumns,andonait'sownvalueaxis.

SubWindow_Onload()

DimasSeriesNames(1)DimasCategories(3)DimaiSeries1(3)DimalSeries2(3)DimchConstantsDimchtNewChartDimserUnitSalesDimserDispIncDimaxIncomeAxis

asSeriesNames(0)="UnitSales"asSeriesNames(1)="DisposableIncome"

asCategories(0)="Item1"asCategories(1)="Item2"asCategories(2)="Item3"asCategories(3)="Item4"

aiSeries1(0)=75aiSeries1(1)=84aiSeries1(2)=30aiSeries1(3)=94

alSeries2(0)=14522

alSeries2(1)=17321alSeries2(2)=9424alSeries2(3)=41782

SetchConstants=ChartSpace1.Constants

'Enagblethedisplayofthelegend.ChartSpace1.HasChartSpaceLegend=True

'AddanewcharttoChartspace1.SetchtNewChart=ChartSpace1.Charts.Add

'Specifythatthechartisacolumnchart.chtNewChart.Type=chConstants.chChartTypeLineMarkers

'Bindthecharttothearrays.chtNewChart.SetDatachConstants.chDimSeriesNames,chConstants.chDataLiteral,asSeriesNameschtNewChart.SetDatachConstants.chDimCategories,chConstants.chDataLiteral,asCategories

SetserUnitSales=chtNewChart.SeriesCollection(0)

serUnitSales.SetDatachConstants.chDimValues,chConstants.chDataLiteral,aiSeries1

SetserDispInc=chtNewChart.SeriesCollection(1)

serDispInc.SetDatachConstants.chDimValues,chConstants.chDataLiteral,alSeries2

'Ungrouptheseries.serDispInc.UngroupTrue

'Addanewvalueaxistothechartbasedonthevaluesintheseries.SetaxIncomeAxis=chtNewChart.Axes.Add(serDispInc.Scalings(chConstants.chDimValues))

'Placetheaxisontherightsideofthechart.axIncomeAxis.Position=chConstants.chAxisPositionRight

'Displaytheseriesascolumns.serDispInc.Type=chConstants.chChartTypeColumnClustered

EndSub

UnMergeMethod

Separatesthespecifiedmergedareaintoindividualcells.Whenyouseparateamergedarea,thevalueinthemergedareaisplacedinthecellintheupper-leftcornerofthearea.Allothercellsarecleared.

expression.UnMerge

expressionAnexpressionthatreturnsaRangeobject.

ExampleThisexampleseparatesthemergedareacontainingcellA1.

Spreadsheet1.ActiveSheet.Range("A1").UnMerge

UnprotectMethod

Removesprotectionfromaworksheetorworkbook.Thismethodhasnoeffectiftheworksheetorworkbookisn'tprotected.ThismethodisequivalenttosettingtheEnabledpropertyoftheProtectionobjecttoFalse.

expression.Unprotect(Password)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

PasswordThisargumentisnotsupportedinthisversionoftheMicrosoftOfficeSpreadsheetComponent.

UpdateMethod

YouusetheUpdatemethodtowritedatacontainedinanXMLmaptoadatasourceboundtoaSOAPWebservice.ReturnsNothing.

expression.Update(ShowDialogs)

expressionRequired.AnexpressionthatreturnsanXmlDataBindingobject.

ShowDialogsOptionalBoolean.SpecifieswhetheradialogboxisdisplayediftheUpdatemethodencountersanerrorthatisreturnedbytheSpreadsheetcomponentitself.WhenShowDialogsissettoTrue,adialogboxisdisplayediftheUpdatemethodencountersanerrorreturnedbytheSpreadsheetcomponent.WhenShowDialogsissettoFalse,dialogboxesforSpreadsheetcomponenterrorsarenotdisplayed.ThedefaultisFalse.

NoteTheShowDialogsargumentdoesnotcontrolwhetheradialogboxwillbedisplayedforerrorsexternaltotheSpreadsheetcomponent,suchaserrorsreturnedbyscriptingcomponents.TopreventadialogboxfromdisplayingforerrorsexternaltotheSpreadsheetcomponent,youmusttrapthoseerrorsinyourscript.

Remarks

IftheUpdatemethodfails,theBindingErroreventoftheSpreadsheetcomponentwillfire,andanyscriptingerrorswillbereturned.TocatchanupdateerroryoumustaddcodetotheBindingErrorevent,ortraperrorsinscript.Duringasynchronousbinding,anyefforttoworkwithanXmlDataBindingobjectprogrammaticallywillfail.YoucanusetheAsyncpropertyoftheXmlDataBindingobjecttodetermineifabindingsupportsasynchronousbinding.YouusetheBindingInProgresspropertyoftheXmlDataBindingobjecttodetermineofanasynchronousbindingisinprogress.

ExampleYoucanaddcodetotheBindingCompletedeventoftheSpreadsheetcomponentthatcallstheUpdatemethodoryoucanusetheBindingInProgresspropertytodetermineifdatabindingisinprogress.ThefollowingexampleusestheUpdatemethodtowritedatabacktothedatasourceofaSOAPWebserviceforallXmlDataBindingobjectsinaSpreadsheetcomponent:

SubUpdateBinding(Spreadsheet1)

Spreadsheet1.ActiveWorkbook.XmlDataBindings.Item(2).Update

EndSub

SubSpreadsheet1_BindingCompleted(bindingID,Action)

IfSpreadsheet1.ActiveWorkbook.XmlDataBindings.Item(bindingID).CanUpdate=TrueThen'Writecodeheretoperformanyadditionalactionsonthisupdatebinding.EndIf

EndSub

NoteForinformationontrappingtheBindingCompletedeventfromscriptrunninginaWebpage,seetheBindingCompletedeventtopic.

UpdatePropertyToolboxMethod

UpdatestheCommandsandOptionswindowfromthecurrentlyselectedobject.

expression.UpdatePropertyToolbox

expressionAnexpressionthatreturnsaSpreadsheetobject.

ValidateMethod

YouusetheValidatemethodtovalidatedatainacellorrangeofcellsintheSpreadsheetcomponent.ReturnsNothing.

expression.Validate

expressionRequired.AnexpressionthatreturnsaRangeobject.

Remarks

TheeasiestwaytocreateoneormoredatavalidationrulesforcellsinaSpreadsheetcomponentistouseMicrosoftExcel.YoucanuseExceltocreateanewspreadsheet,oropenanexistingspreadsheet,andthenusetheExceldatavalidationfeaturestocreatedatavalidationrules.YousavethespreadsheetasanXMLSpreadsheetfileandthensettheSpreadsheetcomponent'sXmlUrlpropertytothesavedfile.ValidationrulescreatedintheXMLSpreadsheetfiletriggervalidationruleerrormessagesonlywhendataisenteredthroughtheuserinterface.Forexample,whenauserentersdataintoacellthatviolatesavalidationrule,avalidationruleerrormessageisdisplayedtotheuser.However,ifdataisenteredintoacellprogrammatically,oriftheImportXmlmethodisusedtoimportanewXMLdatafileintotheSpreadsheetcomponentthatcontainsinvaliddata,noerrormessagesaretriggered.Inthiscircumstance,youcanusetheValidatemethodtodeterminewhethersuchdataisvalid.

TheValidatemethoddoesnotreturnavalueindicatingthatacellorrangeofcellscontainsinvaliddata.IfyouareusingMicrosoftVisualBasicScriptingEdition(VBScript)tovalidatedata,youmustusetheOnErrorResumeNextstatementonthelineimmediatelyprecedingthecalltotheValidatemethod.InthelineimmediatelyafterthecalltotheValidatemethod,usetheNumberpropertyoftheVBScriptErrobjecttotestwhethervalidationsucceeded.

ExampleThefollowingexampleillustratesafunctionthatreturnsTrueifthedatainacellisvalidandFalseifnotitisnotvalid.

DimobjRangeSpreadsheet1.xmlurl="MyXmlSpreadsheetFile.xml"SetobjRange=Spreadsheet1.Workbooks(1).ListObject("EntryID").DataBodyRange

IfValidateRange(objRange)=TrueThen'Validationsucceeded.Else'Validationfailed.EndIf

FunctionValidateRange(objRange)DimlngErrorOnErrorResumeNextobjRange.Validate()lngError=Err.NumberIflngError<>0ThenValidateRange=TrueExitFunctionEndIfValidateRange=FalseEndFunction

ThenextexampleaddsdatatoacellandthenusestheValidatemethodtodeterminewhetherthedatasatisfiesthecell'svalidationrule:

DimobjRange

SetobjRange=Spreadsheet1.ActiveCell

objRange.Value=100OnErrorResumeNext

objRange.Validate

IfErr.Number<>0thenobjRange.Value=""EndIf

ShowAll

ValueToPointMethod

ValueToPointmethodasitappliestotheChAxisobject.

ValueToPointmethodasitappliestotheChSeriesobject.

RemarksUsethexandypropertiesofthereturnedCoordinateobjecttoreturntheXandY-coordinatesforthespecifieddatapoint.

ExampleAsitappliestotheChSeriesobject.

ActiveProperty

ReturnsTrueiftherowrepresentedbytheListRowobjectisselected.Read/writeBoolean.

expression.Active

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

Remarks

SettingtheActivepropertyofaListRowobjectequaltoTrueisnotreflectedintheRangeobjectreturnedbytheSelectionproperty.Toaddarowtoaselectedrange,youmustusetheSelectmethodinstead.

ExampleThisexamplecheckswhetherthespecifiedrowintheXMLlistisselected.

SubIsRowActive()

DimobjListsDimobjLRowsDimobjLRow

SetobjLists=Spreadsheet1.ActiveSheet.ListObjectsSetobjLRows=objLists.Item(1).ListRows'Savelistrowinformationforthethirdrowtoavariable.SetobjLRow=objLRows.Item(3)

'Displaywhetherthecurrentrowisselected.IfobjLRow.ActiveThenMsgBox("Rowisselected.")ElseMsgBox("Rowisnotselected.")EndIf

EndSub

ActiveCellProperty

ReturnsaRangeobjectthatrepresentstheactivecell.Read-only.

expression.ActiveCell

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

Remarks

Becarefultodistinguishbetweentheactivecellandtheselection.Theactivecellisasinglecellinsidethecurrentselection.Theselectionmaycontainmorethanonecell,butonlyoneistheactivecell.

ExampleThisexamplesetsthenumberformatintheactivecellontheworksheet.

Spreadsheet1.ActiveCell.NumberFormat="0.##"

ActiveDataProperty

ReturnsaPivotDataobjectthatrepresentsthedataintheactivePivotTablelist.

expression.ActiveData

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

ActiveObjectProperty

ReturnsorsetsanObjectthatrepresentstheselectedcellinthedetailareaofthePivotTablelist.UsetheValuepropertyofthereturnedobjecttochangethevalueoftheselectedcell.

expression.ActiveObject

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

RemarksThispropertyreturnsNothingifnodetailcellsareselected.

ExampleThisexampleenablestheeditingofdetailrecordsinPivotTable1,thenplacesthecurrentdateintheselecteddetailcell.Theeditingofdetailrecordsisdisallowedoncethedatehasbeeninsertedintotheselectedcell.

SubEditSelectedCell()

DimobjActiveCell

'Alloweditingofdetailrecords.PivotTable1.ActiveView.AllowEdits=True

'Setavariabletothecurrentlyselectedcell.SetobjActiveCell=PivotTable1.ActiveObject

'Checkwhetheradetailcellisselected.IfNotobjActiveCellIsNothingThen

'Setthevalueofthedetailcell'tothecurrentdate.'Note:Thiswillresultinarun-time'errorifthedatatypeoftheselected'celldoesnotsupportdatevalues.objActiveCell.Value=Date

EndIf

'Disalloweditingofdetailrecords.PivotTable1.ActiveView.AllowEdits=False

EndSub

ActivePaneProperty

ReturnsaPaneobjectthatrepresentstheactivespreadsheetpane.Read-only.

expression.ActivePane

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplesetsthevalueofthecellintheupper-leftcornerofthevisiblerangeintheactivepaneonthespreadsheet.

Spreadsheet1.ActivePane.VisibleRange.Cells(1,1).Value="topleft"

ActiveSheetProperty

Returnsaread-onlyWorksheetobjectthatrepresentstheactiveworksheet.

expression.ActiveSheet

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplechangesthenameoftheactiveworksheet.

Spreadsheet1.ActiveSheet.Name="BudgetSheet"

ActiveViewProperty

ReturnsaPivotViewobjectthatrepresentsthelayoutoftheactivePivotTablelist.SettingavariabletotheactiveviewofthePivotTableprovidesyouwithaconvenientmethodtomakechangestotheactiveview.Read-only.

expression.Case

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

ExampleThisexampleinsertstwofieldsetsintheactiveviewofPivotTable1.

SubInsert_Fieldsets()DimvwView

SetvwView=PivotTable1.ActiveView'AddtheStoreTypefieldtothecolumnaxis.vwView.ColumnAxis.InsertFieldSetvwView.FieldSets("StoreType")'AddthePromotionsfieldtotherowaxis.vwView.RowAxis.InsertFieldSetvwView.FieldSets("Promotions")EndSub

ActiveWindowProperty

ReturnsaWindowobjectthatrepresentsthecurrentwindow.

expression.ActiveWindow

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexamplehidestherowandcolumnheadingsintheactivewindowofSpreadsheet1.

SubHideHeadings()Spreadsheet1.ActiveWindow.DisplayColumnHeadings=FalseSpreadsheet1.ActiveWindow.DisplayRowHeadings=FalseEndSub

ActiveWorkbookProperty

ReturnsaWorkbookobjectthatrepresentstheopenworkbook.

expression.ActiveWorkbook

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexampleprotectsthestructureoftheopenworkbookinSpreadsheet1.

Speadsheet1.ActiveWorkbook.Protect,True

ShowAll

AddressProperty

AddresspropertyasitappliestotheHyperlinkandPivotHyperlinkobjects.

AddresspropertyasitappliestotheRangeobject.

ExampleAsitappliestotheHyperlinkobject.

AsitappliestotheRangeobject.

AggregatesProperty

ReturnsthePivotAggregatescollectionforthespecifiedcell.

expression.Aggregates

expressionRequired.AnexpressionthatreturnsaPivotCellobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

AllGroupingDefsProperty

ReturnstheAllGroupingDefscollectionforthedatasourcecontrol.Read-only.

expression.AllGroupingDefs

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ShowAll

AllIncludeExcludeProperty

ReturnsorsetsaPivotFieldSetAllIncludeExcludeEnumthatrepresentstheinclusionstateofallmembersthatarenotlistedintheIncludedMembersorExcludedMemberslistsforthespecifiedfieldset.Read/write.

expression.AllIncludeExclude

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

ExampleThisexamplesetstheincludedandexcludedmembersoftheStoreStateandStoreCityfieldsinPivotTable1.Membersnotlistedintheincludeandexcludelistsareexcluded.

SubMemberFiltering()

DimfldStoreCityDimfldStoreStateDimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'SetavariabletotheStoreStatefield.SetfldStoreState=ptView.FieldSets("Store").Fields("StoreState")

'SetavariabletotheStoreCityfield.SetfldStoreCity=ptView.FieldSets("Store").Fields("StoreCity")

'ExcludeCaliforniaandWashingtonfromtheStoreStatefield.fldStoreState.ExcludedMembers=Array("CA","WA")

'IncludemembersoftheStoreCityfield.Notethatthecitiesare'instatesthathavebeenexcludedbythepreviousline.Since'StoreStateisaparenttoStoreCity,thentheexcludedstates'aredisplayedinthePivotTable.fldStoreCity.IncludedMembers=Array("LosAngeles","SanDiego",_

"Seattle","Spokane")

'ExcludeallmembersthatarenotinthelistfortheIncludedMembersand'ExcludedMembersproperties.ptView.FieldSets("Store").AllIncludeExclude=ptConstants.plAllExclude

EndSub

AllMemberProperty

ReturnsaPivotMemberobjectthatrepresentsthetopmemberinthespecifiedfieldset.

expression.AllMember

expressionRequired.AnexpressionthatreturnsPivotFieldSetobject.

AllowAdditionsProperty

GroupLevelobject:ReturnsorsetsaBooleanthatrepresentswhethertheusercanaddrecordstothespecifiedgroup.SetthispropertytoFalsetopreventusersfromaddingrecordstoagroup.ThedefaultvalueisTrue.Read/write.

PivotViewobject:ReturnsorsetsaBooleanthatrepresentswhethertheusercanaddanewrecordtothedetailareaofaPivotTablelist.SetthispropertytoTruetoallowtheusertoinsertnewrecords.ThedefaultvalueifFalse.Read/write.

expression.AllowAdditions

expressionRequired.AnexpressionthatreturnsaGroupLevelorPivotViewobject.

RemarksWhenthispropertyissettoTrue,anasterisk(*)willbedisplayedinablankrowinthedetailarea.AnynewrecordsaddedtothedetailareaofaPivotTablelistarealsoaddedtothesourcedatabase.

YoucannotaddrecordstothedetailareaofthePivotTablelistifthesourcerecordsetdoesnotallowinsertions.

ExampleThisexampleallowstheusertoaddnewrecordstothedetailareaofPivotTable1.

PivotTable1.ActiveView.AllowAdditions=True

AllowCustomOrderingProperty

Returnsorsetswhethertheusercanreorderrowaxisorcolumnaxismembers.SetthispropertytoFalsetopreventusersfromrowaxisorcolumnaxismemberreordering.ThedefaultvalueisTrue.Read/writeBoolean.

expression.AllowCustomOrdering

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

ExampleThisexamplepreventsusersfromreorderingmembersoftherowaxisorcolumnaxisinPivotTable1.

PivotTable1.AllowCustomOrdering=False

AllowDeletingColumnsProperty

Specifieswhetheraworksheetcolumncanbedeletedwhentheworksheethasbeenprotected.ThedefaultvalueisFalse,butthispropertyhasnoeffectiftheEnabledpropertyoftheProtectionobjectissettoFalse.Read/writeBoolean.

expression.AllowDeletingColumns

expressionRequired.AnexpressionthatreturnsaProtectionobject.

ExampleThisexamplelocksallcellsonSheet1,enablestheinsertionanddeletionofcolumns,andthenprotectsSheet1.

SubProtect_Worksheet()DimptProtSheet1

'Lockallcellsontheworksheet.Spreadsheet1.Worksheets("Sheet1").Cells.Locked=TrueSetptProtSheet1=Spreadsheet1.Worksheets("Sheet1").Protection'AllowsusertodeletecolumnswhileSheet1isprotected.ptProtSheet1.AllowDeletingColumns=True'AllowsusertoinsertcolumnswhileSheet1isprotected.ptProtSheet1.AllowInsertingColumns=True'ProtectSheet1.ptProtSheet1.Enabled=TrueEndSub

AllowDeletingRowsProperty

Specifieswhetheraworksheetrowcanbedeletedwhentheworksheethasbeenprotected.ThedefaultvalueisFalse,butthispropertyhasnoeffectiftheEnabledpropertyoftheProtectionobjectissettoFalse.Read/writeBoolean.

expression.AllowDeletingRows

expressionRequired.AnexpressionthatreturnsaProtectionobject.

ExampleThisexamplelocksallcellsonSheet1,andthenitenablestheinsertionanddeletionofrows,andthenprotectsSheet1.

SubProtect_Worksheet()DimptProtSheet1

'Lockallcellsontheworksheet.Spreadsheet1.Worksheets("Sheet1").Cells.Locked=TrueSetptProtSheet1=Spreadsheet1.Worksheets("Sheet1").Protection'AllowsusertodeleterowswhileSheet1isprotected.ptProtSheet1.AllowDeletingRows=True'AllowsusertoinsertrowswhileSheet1isprotected.ptProtSheet1.AllowInsertingRows=True'ProtectSheet1.ptProtSheet1.Enabled=TrueEndSub

AllowDeletionsProperty

GroupLevelobject:ReturnsorsetsaBooleanthatrepresentswhethertheusercandeleterecordsfromthespecifiedgroup.SetthispropertytoFalsetopreventusersfromdeletingrecordsfromagroup.ThedefaultvalueisTrue.Read/write.

PivotViewobject:ReturnsorsetsaBooleanthatrepresentswhethertheusercandeletearecordfromdetailareaofaPivotTablelist.SetthispropertytoTruetoallowtheusertodeleterecords.ThedefaultvalueisFalse.Read/write.

expression.AllowDeletions

expressionRequired.AnexpressionthatreturnsaGroupLevelorPivotViewobject.

RemarksAnyrecordsthataredeletedfromthedetailareaofaPivotTablelistarealsodeletedfromthesourcedatabase.TheusercannotdeleterecordsfromthedetailareaofthePivotTablelistifthesourcerecordsetdoesnotallowdeletions.

ExampleThisexampleallowstheusertodeleterecordsfromthedetailareaofPivotTable1.

PivotTable1.ActiveView.AllowDeletions=True

AllowDetailsProperty

SpecifieswhethertheusercanexpandaninnermemberofthespecifiedPivotTablelisttodisplaydetailrecords.ThedefaultvalueisTrue.Read/writeBoolean.

expression.AllowDetails

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

RemarksWhenthispropertyisFalse,innermembersdonotdisplayexpandindicators,theExpandcommandisdisabledformostaggregates,anddouble-clickinganaggregatedoesnotdisplaydetaildata.IfthispropertyisFalse,theusercanstillviewdetailsprogrammatically.

ExampleThisexampledisablesdetailviewingforthePivotTablelist.

PivotTable1.AllowDetails=False

AllowEditsProperty

GroupLevelobject:ReturnsorsetsaBooleanthatrepresentswhethertheusercaneditrecordsinthespecifiedgroup.SetthispropertytoFalsetopreventusersfromeditingrecordsinagroup.ThedefaultvalueisTrue.Read/write.

PivotViewobject:ReturnsorsetsaBooleanthatrepresentswhethertheusercaneditcellsinthedetailareaofaPivotTablelist.SetthispropertytoTruetoallowtheusertoeditcellsinthedetailarea.ThedefaultvalueisFalse.Read/write.

expression.AllowEdits

expressionRequired.AnexpressionthatreturnsaGroupLevelorPivotViewobject.

RemarksChangingacellvalueresultsinacorrespondingchangeinthesourcedatabase.Fieldsthataremarkedasread-onlyinthesourcedatabasecannotbeeditedinthePivotTablelist.

ExampleThisexampleenableseditinginthedetailareaofPivotTable1.

PivotTable1.ActiveView.AllowEdits=True

ShowAll

AllowFilteringProperty

AllowFilteringpropertyasitappliestotheProtectionobject.

AllowFilteringpropertyasitappliestothePivotTableobject.

ExampleAsitappliestotheProtectionobject.

AsitappliestothePivotTableobject.

AllowFormattingColumnsProperty

Returnsorsetswhetherornotcolumnscanresizedonaprotectedworksheet.SetthispropertytoTruetoenablecolumnstoberesizedwhentheworksheetisprotected.ThedefaultvalueisFalse.Read/writeBoolean.

expression.AllowFormattingColumns

expressionRequired.AnexpressionthatreturnsaProtectionobject.

ExampleThisexamplelocksallcellsonSheet1,andthenitenablestheusertoresizerowsandcolumns,andthenprotectsSheet1.

SubProtect_Worksheet()DimptProtSheet1

'Lockallcellsontheworksheet.Spreadsheet1.Worksheets("Sheet1").Cells.Locked=True

SetptProtSheet1=Spreadsheet1.Worksheets("Sheet1").Protection

'AllowsusertoresizerowswhileSheet1isprotected.ptProtSheet1.AllowFormattingRows=True

'AllowsusertoresizecolumnswhileSheet1isprotected.ptProtSheet1.AllowFormattingColumns=True

'ProtectSheet1.ptProtSheet1.Enabled=TrueEndSub

AllowFormattingRowsProperty

Returnsorsetswhetherornotrowscanresizedonaprotectedworksheet.SetthispropertytoTruetoenablerowstoberesizedwhentheworksheetisprotected.ThedefaultvalueisFalse.Read/writeBoolean.

expression.AllowFormattingRows

expressionRequired.AnexpressionthatreturnsaProtectionobject.

ExampleThisexamplelocksallcellsonSheet1,andthenitenablestheusertoresizerowsandcolumns,andthenprotectsSheet1.

SubProtect_Worksheet()

DimptProtSheet1

'Lockallcellsontheworksheet.Spreadsheet1.Worksheets("Sheet1").Cells.Locked=True

SetptProtSheet1=Spreadsheet1.Worksheets("Sheet1").Protection

'AllowsusertoresizerowswhileSheet1isprotected.ptProtSheet1.AllowFormattingRows=True

'AllowsusertoresizecolumnswhileSheet1isprotected.ptProtSheet1.AllowFormattingColumns=True

'ProtectSheet1.ptProtSheet1.Enabled=True

EndSub

AllowGroupingProperty

TrueiftheuserisabletogroupfieldsontherowaxisorthecolumnaxisinthespecifiedPivotTablelist.IfthispropertyissettoFalse,thegroupingbuttonsaredisabledbuttheusercanstillgroupfieldsprogrammatically.ThedefaultvalueisTrue.Read/writeBoolean.

expression.AllowGrouping

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksWhenthispropertyissettoFalse,pivotingisdisabled.Thismeansthatmembershipintherowandcolumnareasisfixed;youcannotdragafieldtoorfromtheseareas.Allcommandsrelatedtogroupingaredisabled,includingthefollowingcommands:

MovetoColumnArea

MovetoDetail,iftheselectionisafieldintheroworcolumnarea

MovetoFiltering

MovetoRowArea

IfFalse,thereportlayoutisfrozen,buttheusercanstillfilterthedata.

ExampleThisexampledisablesfieldgroupingforthePivotTablelist.

PivotTable1.AllowGrouping=False

AllowHeadingRenameProperty

Specifieswhetherrowandcolumnheadersinaprotectedworksheetcanbecustomized.SetthispropertytoTruetocustomizethecolumnheadersofaprotectedworksheet.ThedefaultvalueisFalse.Read/writeBoolean.

expression.AllowHeadingRename

expressionRequired.AnexpressionthatreturnsaProtectionobject.

RemarksSettingtheCaptionpropertyofaroworcolumnheadingaftersettingthispropertytoFalseresultsinarun-timeerror.YoumustsettheEnabledpropertyoftheProtectionobjecttoTrueforthispropertytotakeeffect.

ExampleThisexamplelocksallcellsonSheet1,enablestheinsertionanddeletionofcolumns,disablesthecustomizationofrowandcolumnheadings,andthenprotectsSheet1.

SubProtect_Worksheet()

DimptProtSheet1

'Lockallcellsontheworksheet.Spreadsheet1.Worksheets("Sheet1").Cells.Locked=True

SetptProtSheet1=Spreadsheet1.Worksheets("Sheet1").Protection

'AllowsusertodeletecolumnswhileSheet1isprotected.ptProtSheet1.AllowDeletingColumns=True

'AllowsusertoinsertcolumnswhileSheet1isprotected.ptProtSheet1.AllowInsertingColumns=True

'preventrowandcolumnheadingsfrombeingcustomized.ptProtectSheet1.AllowHeadingRename=False

'ProtectSheet1.ptProtectSheet1.Enabled=True

EndSub

AllowInsertingColumnsProperty

Specifieswhetheraworksheetcolumncanbeinsertedwhentheworksheethasbeenprotected.ThedefaultvalueisFalse,butthispropertyhasnoeffectiftheEnabledpropertyoftheProtectionobjectissettoFalse.Read/writeBoolean.

expression.AllowInsertingColumns

expressionRequired.AnexpressionthatreturnsaProtectionobject.

ExampleThisexamplelocksallcellsonSheet1,andthenitenablestheinsertionanddeletionofcolumns,andthenprotectsSheet1.

SubProtect_Worksheet()DimptProtSheet1

'Lockallcellsontheworksheet.Spreadsheet1.Worksheets("Sheet1").Cells.Locked=TrueSetptProtSheet1=Spreadsheet1.Worksheets("Sheet1").Protection'AllowsusertodeletecolumnswhileSheet1isprotected.ptProtSheet1.AllowDeletingColumns=True'AllowsusertoinsertcolumnswhileSheet1isprotected.ptProtSheet1.AllowInsertingColumns=True'ProtectSheet1.ptProtSheet1.Enabled=TrueEndSub

AllowInsertingRowsProperty

Specifieswhetheraworksheetrowcanbeinsertedwhentheworksheethasbeenprotected.ThedefaultvalueisFalse,butthispropertyhasnoeffectiftheEnabledpropertyoftheProtectionobjectissettoFalse.Read/writeBoolean.

expression.AllowInsertingRows

expressionRequired.AnexpressionthatreturnsaProtectionobject.

ExampleThisexamplelocksallcellsonSheet1,andthenitenablestheinsertionanddeletionofrows,andthenprotectsSheet1.

SubProtect_Worksheet()DimptProtSheet1

'Lockallcellsontheworksheet.Spreadsheet1.Worksheets("Sheet1").Cells.Locked=TrueSetptProtSheet1=Spreadsheet1.Worksheets("Sheet1").Protection'AllowsusertodeleterowswhileSheet1isprotected.ptProtSheet1.AllowDeletingRows=True'AllowsusertoinsertrowswhileSheet1isprotected.ptProtSheet1.AllowInsertingRows=True'ProtectSheet1.ptProtSheet1.Enabled=TrueEndSub

AllowLayoutEventsProperty

SetthispropertytoTruetoenabletheAfterLayoutevent.ThedefaultvalueisFalse.Read/writeBoolean.

expression.AllowLayoutEvents

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ExampleThisexampleenablesalleventsforChartSpace1.

SubWindow_Onload()

'AllowtheAfterLayouteventtofire.ChartSpace1.AllowLayoutEvents=True

'AllowBeforeRenderandAfterRenderevents'tofireaseachdatapointisrendered.ChartSpace1.AllowPointRenderEvents=True

'AllowBeforeRenderandAfterRenderevents'tofireaseachchartelementisrendered.'TheAfterFinalRendereventwillfireafter'allchartelementshavebeenrendered.ChartSpace1.AllowRenderEvents=True

'AllowtheBeforeScreenTipeventtofire.ChartSpace1.AllowScreenTipEvents=True

EndSub

AllowMultiFilterProperty

ReturnsorsetswhetherornottheusercanselectmultipleitemswhenthespecifiedfieldsetisinthefilterareaofaPivotTablelist.ThedefaultvalueisTrue.Read/writeBoolean.

expression.AllowMultiFilter

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

RemarksSetthispropertytoFalsetoemulatethebehaviorofafieldsetinthefilterareaoftheMicrosoftOffice2000PivotTableComponent.

ExampleThefollowingexampledisablestheselectionofmultipleitemsintheMerchantfieldwhenitisinthefilterareaofPivotTable1.

PivotTable1.ActiveView.FieldSets("Merchant").AllowMultiFilter=False

AllowPointRenderEventsProperty

SetthispropertytoTruetoenabletheBeforeRenderandAfterRendereventstobecalledaseachdatapointisrendered.ThedefaultvalueisFalse.Read/writeBoolean.

expression.AllowPointRenderEvents

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ExampleThisexampleenablesalleventsforChartSpace1.

SubWindow_Onload()

'AllowtheAfterLayouteventtobecalled.ChartSpace1.AllowLayoutEvents=True

'AllowBeforeRenderandAfterRenderevents'tobecalledaseachdatapointisrendered.ChartSpace1.AllowPointRenderEvents=True

'AllowBeforeRenderandAfterRenderevents'tobecalledaseachchartelementisrendered.'TheAfterFinalRendereventwillfireafter'allchartelementshavebeenrendered.ChartSpace1.AllowRenderEvents=True

'AllowtheBeforeScreenTipeventtobecalled.ChartSpace1.AllowScreenTipEvents=True

EndSub

AllowPropertyToolboxProperty

DetermineswhethertheusercandisplaytheCommandsandOptionsdialogboxatruntime.SettingtheAllowPropertyToolboxpropertytoFalsedisablestheCommandsandOptionsbuttononthetoolbar.ThedefaultvalueisTrue.Read/writeBoolean.

expression.AllowPropertyToolbox

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampledisablestheCommandsandOptionsbuttonontheSpreadsheeet1toolbaratruntime.

Spreadsheet1.AllowPropertyToolbox=False

AllowRenderEventsProperty

SetthispropertytoTruetoenabletheBeforeRender,AfterRender,andAfterFinalRenderevents.ThedefaultvalueisFalse.Read/writeBoolean.

expression.AllowRenderEvents

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ExampleThisexampleenablesalleventsforChartSpace1.

SubWindow_Onload()

'AllowtheAfterLayouteventtofire.ChartSpace1.AllowLayoutEvents=True

'AllowBeforeRenderandAfterRenderevents'tofireaseachdatapointisrendered.ChartSpace1.AllowPointRenderEvents=True

'AllowBeforeRenderandAfterRenderevents'tofireaseachchartelementisrendered.'TheAfterFinalRendereventwillfireafter'allchartelementshavebeenrendered.ChartSpace1.AllowRenderEvents=True

'AllowtheBeforeScreenTipeventtofire.ChartSpace1.AllowScreenTipEvents=True

EndSub

AllowScreenTipEventsProperty

SetthispropertytoTruetoenabletheBeforeScreenTipevent.ThedefaultvalueifFalse.Read/writeBoolean.

expression.AllowScreenTipEvents

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksTheBeforeScreenTipeventallowsyoutomodifyScreenTipsbeforetheyaredisplayed.

ExampleThisexampleenablesalleventsforChartSpace1.

SubWindow_Onload()

'AllowtheAfterLayouteventtobecalled.ChartSpace1.AllowLayoutEvents=True

'AllowBeforeRenderandAfterRenderevents'tofireaseachdatapointisrendered.ChartSpace1.AllowPointRenderEvents=True

'AllowBeforeRenderandAfterRenderevents'tobecalledaseachchartelementisrendered.'TheAfterFinalRendereventwillbecalledafter'allchartelementshavebeenrendered.ChartSpace1.AllowRenderEvents=True

'AllowtheBeforeScreenTipeventtobecalled.ChartSpace1.AllowScreenTipEvents=True

EndSub

AllowSortingProperty

Specifieswhetheraworksheetcanbesortedwhentheworksheethasbeenprotected.ThedefaultvalueisFalse,butthispropertyhasnoeffectiftheEnabledpropertyoftheProtectionobjectissettoFalse.Read/writeBoolean.

expression.AllowSorting

expressionRequired.AnexpressionthatreturnsaProtectionobject.

ExampleThisexamplelocksallcellsonSheet1,enablesthefilteringandsortingofrowsandcolumns,andthenprotectstheworksheet.

SubProtect_Worksheet()DimptProtSheet1

'Lockallcellsontheworksheet.Spreadsheet1.Worksheets("Sheet1").Cells.Locked=TrueSetptProtSheet1=Spreadsheet1.Worksheets("Sheet1").Protection'AllowsusertofilterrowswhileSheet1isprotected.ptProtSheet1.AllowFiltering=True'AllowsusertosortrowsandcolumnswhileSheet1isprotected.ptProtSheet1.AllowSorting=True'ProtectSheet1.ptProtSheet1.Enabled=TrueEndSub

AllowUISelectionProperty

Returnsorsetswhetheranelementonachartisselectedwhentheuserclicksonanelementwiththemouse.Read/writeBoolean.

expression.AllowUISelection

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

Remarks

IfthispropertyissettoTrue,whenauserclicksonachartelementwiththemouse,thecurrentlistofselectionsisemptiedandreplacedwithonlytheelementthatwasclickedbytheuser.IfthispropertyissettoFalse,whentheuserclicksonanelementwiththemouse,thecurrentlistofselectionsispreservedandthemouseclickeventisignored.ThedefaultvalueisTrue.

ExampleThefollowingexampledisablestheAllowUISelectionproperty.

ChartSpace1.AllowUISelection=False

AllPageFieldsProperty

ReturnstheAllPageFieldscollectionforthedatasourcecontrol.Read-only.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

AlternateDataSourceProperty

ReturnsorsetstheIDofthealternatedatasource(anothercomplexdata-boundcontrolthatwillbeusedasthedatasource).Read/writeString.

expression.AlternateDataSource

expressionRequired.AnexpressionthatreturnsanElementExtensionobject.

AlternateRowColorProperty

ReturnsorsetsaStringthatrepresentsthecolortouseforeveryotherrowinthespecifiedgroup.Read/write.

expression.AlternateRowColor

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

AlwaysIncludeInCubeProperty

ReturnsorsetswhetherthespecifiedfieldsetisalwaysincludedinthePivotTablelist'slocalcache.SetthispropertytoTruetoensurethatthespecifiedfieldsetisincludedinthelocalcache.ThedefaultvalueisFalse.Read/writeBoolean.

expression.AlwaysIncludeInCube

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

RemarksSettingthispropertytoTrueforafieldsetensuresthatcalculatedtotalsthatdependonthefieldsetwillcalculatecorrectly.

AmbientLightIntensityProperty

ReturnsorsetsaDoublespecifyingthepercentageofambientlightilluminatingathree-dimensionalchart.Validsettingsrangefrom0to1.Read/write.

expression.AmbientLightIntensity

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DBarchartandsetsthelightingoptionsforthechart.

SubFormat3DLightSources()

Dimcht3DBar

'SetavariabletothefirstchartinChartspace1.Setcht3DBar=ChartSpace1.Charts(0)

'Changethecharttoa3DBarchart.cht3DBar.Type=chChartTypeBar3D

'Settheintensityoftheambientlight.cht3DBar.AmbientLightIntensity=0.7

'Settheinclinationofthedirectionallightsource.cht3DBar.DirectionalLightInclination=35

'Settheintensityofthedirectionallightsource.cht3DBar.DirectionalLightIntensity=0.8

'Settherotationofthedirectionallightsource.cht3DBar.DirectionalLightRotation=120

EndSub

AmountProperty

Returnsorsetstheerroramountforfixed-valueandpercentageerrorbars.Youspecifydata-bounderrorbaramountsbyusingtheSetDatamethod.Read/writeDouble.

expression.Amount

expressionRequired.AnexpressionthatreturnsaChErrorBarsobject.

RemarksThisvalueismathematicallycorrect,meaningthat5%isrepresentedas0.05andnot5.Anerrorbarwiththefixedamountof5willbecome500%whenchangedtoapercentage.

ExampleThisexampleaddserrorbarstoalloftheseriesinthefirstchartofChartSpace1andthensetstheerroramount.

SubAdd_Error_Bars()DimebErrorBarsDimserChartSeriesDimchConstants

SetchConstants=ChartSpace1.Constants

'Loopthroughalloftheseriesinthefirstchart'ofChartSpace1.ForEachserChartSeriesinChartSpace1.Charts(0).SeriesCollection

'Adderrorbarstothecurrentseries.SetebErrorBars=serChartSeries.ErrorBarsCollection.Add

'Settheerrorbarstobeapercentageofthevalue.ebErrorBars.Type=chConstants.chErrorBarTypePercent

'Setthepercentageamount.ebErrorBars.Amount=0.05NextEndSub

ShowAll

ApplicationProperty

ApplicationpropertyasitappliestoallobjectsintheAppliesTolistexceptfortheOWCLanguageSettingsobject.

ApplicationpropertyasitappliestotheOWCLanguageSettingsobject.

AspectRatioProperty

ReturnsorsetsaLongspecifyingtheratioofheighttothewidthofthespecifiedthree-dimensionalchart.Settingthispropertytoavaluegreaterthan100willmakeachartwhichistallerthanitiswide,whileavaluelessthan100willmakeachartwiderthanitistall.Validsettingsrangefrom0to500.Read/write.

expression.AspectRatio

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksThispropertyhasnoeffectona3-DPiechart.UsetheThicknesspropertytoincreasethethicknessofa3-DPiechart.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthenincreasesthewidthanddepthofthechart.

SubFormat3DDepthWidth()

Dimcht3DColumn

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3-DColumnchart.cht3DColumn.Type=chChartTypeColumnClustered3D

'Increasethedepthofthechartinrelation'toit'swidth.cht3DColumn.ChartDepth=125

'Increasethewidthofthechartinrelation'toit'sheight.cht3DColumn.AspectRatio=80

EndSub

AsyncProperty

IndicateswhetherthebindingoftheXMLDataBindingobjectisasynchronousornot.Read-only.

expression.Async

expressionRequired.AnexpressionthatreturnsanXmlDataBindingobject.

Remarks

YoucanusetheAsyncpropertyoftheXmlDataBindingobjecttofindoutifabindingsupportsasynchronousbinding.ItreturnsTrueifthebindingisasynchronous,otherwiseitreturnsFalse.ThedefaultvalueisFalse.

ItonlyaffectsthebehaviorofQuerybindings.WhenthevalueisTrue,onpageload,theSpreadsheetcomponentwillrenderalongwithanystaticdatabeforetheLoadMode=Normalbindingsactuallyoccurs.Whileasynchronousbindingsareinprogress,theSpreadsheetcomponentwillbenon-interactive(sameasViewOnlymode).Oncethebindingisdoneandtheeventshaveoccured,theuserinterfacewillbecomeinteractive.

WhenthevalueisFalse,thepagewillnotrenderuntilbindingswhereLoadMode=Normalhavecompletedloading.SubsequentrefreshoperationswithuserinterfacecommandsorwithcallstotheRefreshmethodwillnotresponduntilbindingoperationshavecompleted.

Whenanasynchronousbindingisinprogress,anyattempttoworkwithanXmlDataBindingobjectprogrammaticallywillfail.

ExampleThefollowingVBScriptexamplechecksifthebindingstateofthefirstXMLDataBindingobjectintheXMLDataBindingscollectionisasynchronous.Ifitis,amessageboxisdisplayed.

SubAsync()

DimobjBindingSetobjBinding=Spreadsheet1.ActiveWorkbook.XmlDataBindings.Item(1)

'Checktoseeifthebindingisasynchronous.IfobjBinding.Async=TrueThen

'Alerttheuserifthebindingstateisasynchronous.MsgBox("Thebindingisasynchronous.")

EndIf

EndSub

AutoFilterProperty

ReturnstheAutoFilterobjectforthespecifiedworksheet.

expression.AutoFilter

expressionAnexpressionthatreturnsaWorksheetobject.

RemarksDonotconfusethispropertywiththeAutoFiltermethod.ThispropertyreturnstheAutoFilterobjectforagivenworksheet,whereastheAutoFiltermethodappliestoaRangeobjectandturnsontheAutoFilter.

ExampleThisexampleturnsontheAutoFilterfortherangeA1:C20,setsfiltersforcolumnsAandC,andthenappliesthefilters.

SubApply_AutoFilter()DimafFiltersDimafCol1DimafCol3'TurnonAutoFilter.Spreadsheet1.Worksheets("Sheet1").Range("A1:C20").AutoFilter'SetavariabletotheAutoFilterobject.SetafFilters=Spreadsheet1.Worksheets("sheet1").AutoFilterSetafCol1=afFilters.Filters(1)SetafCol3=afFilters.Filters(3)'AddacriteriathatexcludesbluefromcolumnA.afCol1.Criteria.Add"blue"'AddacriteriathatexcludesgreenfromcolumnA.afCol1.Criteria.Add"green"'AddacriteriathatexcludesyellowfromcolumnC.afCol3.Criteria.Add"yellow"'Applythecriteria.afFilters.ApplyEndSub

AutoFilterModeProperty

ReturnsTrueiftheAutoFilterdrop-downarrowsarecurrentlydisplayed.YoucansetthispropertytoFalsetohidethearrows,butyoucannotsetittoTrue.UsetheAutoFiltermethodtofilteralistanddisplaythedrop-downarrows.Read/writeBoolean.

expression.AutoFilterMode

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

RemarksIftheAutoFilterdrop-downarrowsarevisiblebutnorowsarecurrentlyfiltered(allrowsarevisible),theAutoFilterModepropertyisTrueandtheFilterModepropertyisFalse.

ExampleThisexampleturnsofftheAutoFilterfortheactiveworksheet.

Spreadsheet1.ActiveSheet.AutoFilterMode=False

AutoFitProperty

SpreadsheetorPivotTableobjects:TrueiftheoverallsizeofthespreadsheetorPivotTablelistisdeterminedbythenumberofvisiblecolumnsandrows.Therowheightandcolumnwidthcannotexceedthevalueofthespreadsheet’sorPivotTablelist’sMaxHeightandMaxWidthproperties.ThedefaultvalueisTrue.IftheAutoFitpropertyissettoFalse,theoverallsizeofthespreadsheetorPivotTablelistissetbasedonitsWidthandHeightproperties.Read/writeBoolean.

PivotAxisMemberorPivotTotalobjects:Trueifthewidthofthetotalissetautomatically.ThedefaultvalueisTrue.WhenthispropertyissettoTrue,anylayoutchangealsoupdatestheWidthandHeightpropertyvalues.WhenyouchangetheWidthandHeightvaluesprogrammatically,thevalueoftheAutoFitpropertyissettoFalse.Read/writeBoolean.

expression.AutoFit

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampledisablesautomaticsizingforthePivotTablelistandthensetsitswidth.

NoteTheobjectpropertyoftheOBJECTHTMLelementisusedtoaccesstheWidthpropertyofthePivotTableobject(PivotTable1.Object.Width)becausetheOBJECTelementonanHTMLpagealsohasitsownWidthproperty.ThisisnotnecessarywhenaPivotTablecontrolisonauserformorotherActiveXcontainer.

SubDisableAutoFit()

PivotTable1.AutoFit=FalsePivotTable1.Object.Width=8000

EndSub

AxesProperty

ReturnstheChAxescollectionforthespecifiedchart.UsetheAxespropertytosetthepropertiesforachartaxis.Read-only.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

expression.Axes

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleaddsatitleto,andchangesthefontofthevalueandcategoryaxesofthefirstchartinChartSpace1.

SubFormat_Chart_Axes()

DimaxCategoryAxisDimaxValueAxis

'SetavariabletotheCategory(X)axis.SetaxCategoryAxis=ChartSpace1.Charts(0).Axes(0)'SetavariabletotheValue(Y)axis.SetaxValueAxis=ChartSpace1.Charts(0).Axes(1)

'Thefollowingtwolinesofcodeenable,andthen'setthetitleforthecategoryaxis.axCategoryAxis.HasTitle=TrueaxCategoryAxis.Title.Caption="SalesbyQuarter"'Thefollowingthreelinesofcodesetthefont'forthevaluesdisplayedonthecategoryaxis.axCategoryAxis.Font="Tahoma"axCategoryAxis.Font.Size=8axCategoryAxis.Font.Bold=True

'Thefollowingtwolinesofcodeenable,andthen'setthetitleforthevalueaxis.axValueAxis.HasTitle=TrueaxValueAxis.Title.Caption="Dollars($)"

'Thefollowingthreelinesofcodesetthefont'forthevaluesdisplayedonthevalueaxis.axValueAxis.Font="Tahoma"axValueAxis.Font.Size=8axValueAxis.Font.Bold=Trueendsub

ShowAll

AxisProperty

AxispropertyasitappliestothePivotResultFieldandPivotResultGroupFieldobjects.

AxispropertyasitappliestothePivotAxisMember,PivotColumnMember,PivotPageMember,andPivotRowMemberobjects.

BackColorProperty

Returnsorsetsthebackgroundcolorforthespecifiedobjectorarea.Whenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-blue(RGB)colorvalueoraStringvaluerepresentingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(forexample,redisRGB(255,0,0)).Read/writeVariant.expression.BackColor

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksThispropertyalwaysreturnsthecolorasaLongvaluerepresentinganRGBcolorvalue.

ExampleThisexamplesetsthefontsize,foregroundcolor,andbackgroundcolorforthetitlebarinPivotTable1.

SubFormat_Titlebar()DimvwViewSetvwView=PivotTable1.ActiveView'Setthebackgroundcolorofthetitlebar.vwView.Label.BackColor="DarkSalmon"'Setthefontsizeofthetitlebar.vwView.Label.Font.Size=16'Settheforegroundcolorofthetitlebar.vwView.Label.ForeColor="Sienna"EndSub

BackWallProperty

ReturnsaChSurfaceobjectthatrepresentsthebackwallofathree-dimensionalchart.UsethepropertiesandmethodsofthereturnedChSurfaceobjecttoformatthebackwallofthespecifiedchart.

expression.BackWall

expressionRequired.AnexpressionthatreturnsaChPlotAreaobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthenformatsthebackwall,sidewall,andfloorofthechart.

SubFormatWallsFloor()

Dimcht3DColumnDimchConstantsDimpaPlotArea

SetchConstants=ChartSpace1.Constants

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Setavariabletotheplotarea.SetpaPlotArea=cht3DColumn.PlotArea

'Changethecharttoa3DColumnchart.cht3DColumn.Type=chConstants.chChartTypeColumnClustered3D

'Formatthebackwallofthechart.paPlotArea.BackWall.Interior.SetSolid"Yellow"paPlotArea.BackWall.Thickness=5

'Formatthesidewallofthechart.paPlotArea.SideWall.Interior.SetSolid"Yellow"paPlotArea.SideWall.Thickness=5

'Formatthefloorofthechart.paPlotArea.Floor.Interior.SetSolid"Blue"

paPlotArea.Floor.Thickness=5

EndSub

BarWidthProperty

Usetosetorspecifyaspecificwidthforthedatamarkersinbarandcolumncharts.ReturnsLong.Read/writeLong.

expression.BarWidth

expressionRequired.AnexpressionthatreturnsaChChartobject.

Remarks

TheBarWidthpropertyisspecifiedinhundredthsofapoint(1/7200ofaninch.)Thedefaultvalueofzero(0)means"automatic".

SettingthispropertychangesthescrollviewextentoftheChScrollViewobjectofachartcontrol.Thispropertyisonlyvalidforbarandcolumncharts.Ithasnoeffectonothercharttypes.ThispropertyhasaneffectonlyiftheHorizontalExtentMaxpropertyforthecolumnchartsandtheVerticalExtentMaxpropertyforthebarchartarenon-zero.

AfteryousettheBarWidthproperty,userswon'tbeabletochangetheHorizontalExtentorVerticalExtentproperties.ChangingtheHorizontalExtentorVerticalExtentpropertieswillhavenoeffectbecausetheBarWidthpropertyvaluewilloverrideanyHorizontalExtentorVerticalExtentvaluesandmaintainthebarwidthuntiltheBarWidthpropertyisdisabled.YoudisabletheBarWidthpropertybysettingittozero(0).

ExampleTheexamplebelowshowsyouhowtosetthebarwidthofthecharttooneinchbysettingitsvalueto7200.Ifyouwanttosetthebarwidthtohalfaninch,thevaluetospecifywouldbe3600.

Chartspace1.Charts(0).Barwidth=7200

BaseNameProperty

Returnsthenameofthespecifiedfieldasitappearsinthesourcedatabase.Read-onlyString.

expression.BaseName

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksAfieldcanhaveseveralnames,asshowninthefollowingtable.

Name DescriptionCaption Thenametheusersees.Name Thenameusedtoidentifythefieldincode.DataField Thenameofthefieldintheunderlyingrecordset.(Thisisnot

necessarilythesameasthebasename;youcanuseadifferentnameifthereisanamingconflictorifyouwanttomakethenameeasiertouseandremember.)

BaseName Thenameofthefieldintheoriginalsourcedatabase.

BeginProperty

ReturnsaChSegmentBoundaryobjectthatrepresentsthebeginningofasegmentboundaryonaformatmap.

expression.Begin

expressionRequired.AnexpressionthatreturnsaChSegmentobject.

RemarksUsetheValuepropertyofthereturnedChSegmentBoundaryobjecttosetthebeginningvalueforthespecifiedsegmentoftheformatmap.UsetheInterior,Line,andBorderpropertiestoformatthesegmentboundary.

ExampleThisexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreatedthathighlightsthebottom10%ofthevaluesinredandthetop20%ofvaluesingreen.

SubWindow_Onload()

Dimserseries1DimsegBottom10PctDimsegTop20PctDimchConstants

SetchConstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;PersistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=SeverName;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderdetailstable.ChartSpace1.SetDatachConstants.chDimCategories,chConstants.chDataBound,"ProductID"ChartSpace1.SetDatachConstants.chDimValues,chConstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachConstants.chDimFormatValues,chConstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.Setserseries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.Thissegmentwill'representthebottom10%ofvaluesinthechart.SetsegBottom10Pct=serseries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segBottom10Pct.Begin.ValueType=chConstants.chBoundaryValuePercentsegBottom10Pct.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto10%.segBottom10Pct.Begin.Value=0segBottom10Pct.End.Value=0.1

'Formattheinteriorofthematchingvalues.segBottom10Pct.Begin.Interior.Color="red"segBottom10Pct.End.Interior.Color="red"

'Addasegmenttotheformatmap.Thissegmentwill'representthetop20%ofvaluesinthechart.SetsegTop20Pct=serseries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segTop20Pct.Begin.ValueType=chConstants.chBoundaryValuePercentsegTop20Pct.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto80%,andtheendingvalueto100%.segTop20Pct.Begin.Value=0.8segTop20Pct.End.Value=1

'Formattheinteriorofthematchingvalues.segTop20Pct.Begin.Interior.Color="Green"segTop20Pct.End.Interior.Color="Green"

EndSub

BindingDataProperty

ReturnsorsetstheconfigurationdataforagivenXmlDataBindingobject.Read/writeString.

expression.BindingData

expressionRequired.AnexpressionthatreturnsanXmlDataBindingobject.

Remarks

TheXmlDataBindingobjectcontainsconfigurationdataintheformofXML.TheformatoftheconfigurationdatamustfollowtheSpreadsheetcomponentXMLschemaasdefinedintheXMLspreadsheetfile.TheBindingIdisanewXMLfragmentthatmustbethesameasthecurrentvalue,orarun-timeerrorwillbegenerated.TheBindingIDistheIDattributeofanXmlDataBindingobjectandmustbeuniqueacrossallworksheetsinaworkbook.

ExampleThefollowingexamplefirstgetsthenumberofXMLDataBindingobjectsintheXmlDataBindingscollectionoftheWorkbookobject.ThenititeratesthrougheachoftheXMLDataBindingobjectstogettheBindingDataproperty.

SubViewBindings()

DimstrXmlDimintBindingDimintCounter

'GetthenumberofXmlDataBindingobjectsintheXmlDataBindingscollection.intBinding=Spreadsheet1.ActiveWorkbook.XmlDataBindings.Count'Displayamessagebox. MsgBox("Thereare"&intBinding&"XmlDataBindingobjectsinthecollection") 'LoopthrougheachXmlDataBindingobjectinthecollection.intCounter=1ForintCounter=1tointBinding

'GettheconfigurationdataforagivenXmlDataBindingobjectfromaXmlDataBindingscollection. strXml=Spreadsheet1.ActiveWorkbook.XmlDataBindings.Item(intCounter).BindingData MsgBox("Bindingitem#"&intCounter&"returnedXML:"&chr(10)&strXml) Next

EndSub

ShowAll

BindingInProgressProperty

AsitappliestotheXmlDataBindingobject.

AsitappliestotheXmlDataBindingscollection.

ExampleAsitappliestotheXmlDataBindingscollection.

BoldProperty

Fontobject:Trueifthespecifiedfontisbold.Read/writeVariant(returnsNullifsomecellsintherangeareboldandsomearenot).UsetheIsNullfunctiontodeterminewhetherthereturnvalueisNull.

PivotFontandChFontobjects:ReturnsorsetsaBooleanthatdetermineswhetherthefontforthespecifiedobjectisbold.Read/write.

expression.Bold

expressionRequired.Anexpressionthatreturnsoneoftheaboveobjects.

ExampleThisexamplesetsfontpropertiesforthespecifiedaxisinthechartworkspace.

SubSetAxisFont()

Dimaxs

Setaxs=ChartSpace1.Charts(0).Axes(1)

axs.Font.Name="Arial"axs.Font.Size=8axs.Font.Bold=True

EndSub

BookmarkProperty

ReturnsaVariantthatidentifiesthebookmarkinthecurrentADOrecordset.Read-only.

expression.Bookmark

expressionRequired.AnexpressionthatreturnsaPivotDetailCellobject.

BorderProperty

ReturnsaChBorderobjectthatrepresentstheborderofthespecifiedobject.

expression.Border

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksTheborderforachartseriesrepresentstheoutlinecoloroncolumn,bar,pie,doughnut,area,andhigh-low-closecharts.Onchartswithmarkers(suchasalinechartwithmarkers),theborderrepresentstheoutlinecolorforthemarkers.

ExampleThisexamplesetsthelineweightoftheborderforthespecifiedseriesinthechartworkspace.

SubSetBorder()

DimchConstants

SetchConstants=ChartSpace1.Constants

ChartSpace1.Charts(0).SeriesCollection(0).Border_.Weight=chConstants.owcLineWeightMedium

EndSub

BordersProperty

ReturnsaBorderscollectionthatrepresentsthefourbordersofarangeofcells.Read-only.

expression.Borders

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexampleaddsamedium-weightgreenbordertoeachcellintherangeB5:C10onSheet1.

SubSetBorders()DimssConstantsDimrngBorderSetssConstants=Spreadsheet1.Constants'Setavariabletotherangetoaddthebordersto.SetrngBorder=Spreadsheet1.Worksheets("Sheet1").Range("b5:c10")

'Settheborderweight.rngBorder.Borders.Weight=ssConstants.owcLineWeightMedium'Setthebordercolor.rngBorder.Borders.Color="green"EndSub

ShowAll

BottomProperty

BottompropertyasitappliestotheChPlotAreaobject.

BottompropertyasitappliestotheChartSpace,ChAxis,ChCategoryLabel,ChChart,ChChartField,ChDataLabel,ChDataLabels,ChDropZone,ChErrorBars,ChLegend,ChLegendEntry,ChPoint,ChSeries,ChScrollView,ChTitle,andChTrendlineobjects.

ShowAll

BottomRightProperty

BottomRightpropertyasitappliestothePivotRangeobject.

BottomRightpropertyasitappliestothePivotDetailRangeobject.

BoundFieldProperty

ReturnsthePivotFieldobjectusedfordata-bindinginformationwhenthesourceisarecordset.Whenthesourceismultidimensional,thispropertyreturnsNothing.

expression.BoundField

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

BubbleScaleProperty

Returnsorsetsascalefactorforallbubbleseriesonthespecifiedchart.Thedefaultvalueis100,andthevalidrangeis0–300.Thevalueofthispropertyindicatesthebubblesizerelativetothedefaultsetting.SettingtheBubbleScalepropertyto300(threetimesgreaterthanthedefaultvalue)producesachartonwhichthebubblesappearthreetimesthedefaultsize.Read/writeDouble.

expression.BubbleScale

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexamplesetsthebubblescalefactorforthespecifiedchartinthechartworkspace.NotethatCharts(0)mustrefertoabubblechart.

ChartSpace1.Charts(0).BubbleScale=200

BuildProperty

ReturnsaLongthatrepresentstheMicrosoftOfficeWebComponentsbuildnumber.Read-only.

expression.Build

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

RemarksThispropertyreturnsthesameinformationastheBuildNumberproperty,butasaLonginsteadofasaString.

BuildNumberProperty

ReturnstheMicrosoftOfficeWebComponentsbuildnumber.Read-onlyString.

expression.BuildNumber

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampledisplaystheMicrosoftOfficeWebComponentsbuildnumberintheactivecellofSpreadsheet1.

Spreadsheet1.ActiveCell.Value="MSOWCBuild"&Spreadsheet1.BuildNumber

ButtonBorderProperty

ReturnsaChBorderobjectthatrepresentstheborderofeachbuttoninthespecifieddropzone.UsethepropertiesofthereturnedChBorderobjecttoformattheborderofeachbuttoninthedropzone.

expression.ButtonBorder

expressionRequired.AnexpressionthatreturnsaChDropZoneobject.

ExampleThisexampleformatsthebuttonandthewatermarkoftheseriesdropzoneinChartspace1.

SubSetupDropZone()

DimdzSeriesDropZoneDimChConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Thenextthreelinesofcodeformatthebuttonofthedropzone.dzSeriesDropZone.ButtonBorder.Weight=chConstants.owcLineWeightMediumdzSeriesDropZone.ButtonInterior.SetSolid"Red"dzSeriesDropZone.ButtonFont.Size=14

'Thenextthreelinesofcodeformatthewatermarkofthedropzone.dzSeriesDropZone.WatermarkBorder.Color="Red"dzSeriesDropZone.WatermarkFont.Color="Red"dzSeriesDropZone.WatermarkInterior.SetSolid"Green"

EndSub

ButtonFontProperty

ReturnsaChFontobjectthatrepresentsthefontofeachbuttoninthespecifieddropzone.UsethepropertiesofthereturnedChFontobjecttoformatthefontofeachbuttoninthedropzone.

expression.ButtonFont

expressionRequired.AnexpressionthatreturnsaChDropZoneobject.

ExampleThisexampleformatsthebuttonandthewatermarkoftheseriesdropzoneinChartspace1.

SubSetupDropZone()

DimdzSeriesDropZoneDimChConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Thenextthreelinesofcodeformatthebuttonofthedropzone.dzSeriesDropZone.ButtonBorder.Weight=chConstants.owcLineWeightMediumdzSeriesDropZone.ButtonInterior.SetSolid"Red"dzSeriesDropZone.ButtonFont.Size=14

'Thenextthreelinesofcodeformatthewatermarkofthedropzone.dzSeriesDropZone.WatermarkBorder.Color="Red"dzSeriesDropZone.WatermarkFont.Color="Red"dzSeriesDropZone.WatermarkInterior.SetSolid"Green"

EndSub

ButtonInteriorProperty

ReturnsaChInteriorobjectthatrepresentstheinteriorofeachbuttoninthespecifieddropzone.UsethepropertiesofthereturnedChInteriorobjecttoformattheinteriorofeachbuttoninthedropzone.

expression.ButtonInterior

expressionRequired.AnexpressionthatreturnsaChDropZoneproperty.

RemarksBydefault,thechartcontrolusesthecolorsettingspecifiedfor3DObjectsontheAppearancetaboftheDisplayControlPanelastheinteriorcolorfordropzonebuttons.

ExampleThisexampleformatsthebuttonandthewatermarkoftheseriesdropzoneinChartspace1.

SubSetupDropZone()

DimdzSeriesDropZoneDimChConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Thenextthreelinesofcodeformatthebuttonofthedropzone.dzSeriesDropZone.ButtonBorder.Weight=chConstants.owcLineWeightMediumdzSeriesDropZone.ButtonInterior.SetSolid"Red"dzSeriesDropZone.ButtonFont.Size=14

'Thenextthreelinesofcodeformatthewatermarkofthedropzone.dzSeriesDropZone.WatermarkBorder.Color="Red"dzSeriesDropZone.WatermarkFont.Color="Red"dzSeriesDropZone.WatermarkInterior.SetSolid"Green"

EndSub

ShowAll

CalculationProperty

ReturnsorsetsanXlCalculationconstantspecifyingthecalculationmode.Read/write.

expression.Calculation

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexampleplacesSpreadsheet1intomanualcalculationmode.

SubManualCalculationMode()

DimssConstants

SetssConstants=Spreadsheet1.Constants

'SetSpreadsheet1tomanualcalculationmode.Spreadsheet1.Calculation=ssConstants.xlCalculationManual

EndSub

CalculationVersionProperty

Returnsanumberwhoserightmosttwodigitsaretheminorversionnumberofthecalculationengine,andwhoseotherdigits(ontheleft)arethemajorversionoftheMicrosoftOfficeSpreadsheetComponent.Read-onlyLong.

expression.CalculationVersion

expressionRequired.AnexpressionthatreturnsaSpreadsheetorWorkbookobject.

CanQueryProperty

ReturnsTrueiftheXmlDataBindingobject(asspecifiedinthe<Binding>elementintheXMLSpreadsheetfile)containsachild<DataSource>elementwithaPurposeattribute(/Binding/DataSource/ConnectionInfo@Purpose)thathasthevalue"Query".OtherwiseitreturnsFalse.Read-only.

expression.CanQuery

expressionRequired.AnexpressionthatreturnsanXmlDataBindingobject.

Remarks

IfTrueisreturned,thePurposeattributeofthe<DataSource>elementhasthevalue"Query".ThismeansyoucancalltheRefreshmethodoftheXmlDataBindingobjecttorequerythedatasource.NotethatanXMLDataBindingobjectcancontainmorethanone<DataSource>elementtag:oneinwhichPurposehasthevalue"Query"andoneinwhichPurposeis"Update".Forinformationonupdatebindings,seetheCanUpdateproperty.

AnXMLDataBindingobjectrepresentsabindingtoanXMLfile,aSOAPservice,anotherWebpart(onlywhenbindingfromaSpreadsheetWebPart),oradataretrievalserviceconnection.

TheXMLfragmentwherethe<DataSource>elementdetailsappearintheXMLSpreadsheetfilelookssomethinglikethefollowing:

<x2:Bindingx2:ID="Cust_bind_id"x2:LoadMode="Normal"x2:Async="False"><x2:MapID>Cust_MapId</x2:MapID><udc:DataSourceMajorVersion="1"MinorVersion="0"><udc:TypeType="XMLFile"MajorVersion="1"MinorVersion="0"/><udc:Name>sample_name</udc:Name><udc:ConnectionInfoPurpose="Query">...</udc:ConnectionInfo></udc:DataSource>

ExampleThefollowingexampleattemptstorefreshabinding.ThiswillcauseaneventhandlerfortheBindingCompletedeventtorun,whichdetermineswhetherabindingcanbequeried(thatis,whetheritsPurposeattributehasthevalue"Query").Youcanwritecodeintheeventhandlertoperformanyadditionalactionsonthebinding.

SubRefreshBinding(Spreadsheet1)DimobjBinding

SetobjBinding=Spreadsheet1.ActiveWorkbook.XmlDataBindings("Cust_bind_id")objBinding.Refresh

EndSub

SubSpreadsheet1_BindingCompleted(bindingID,Action)

IfSpreadsheet1.ActiveWorkbook.XmlDataBindings.Item(bindingID).CanQuery=TrueThen'Writecodeheretoperformanyadditionalactionsonthisquerybinding.EndIf

EndSub

NoteForinformationontrappingtheBindingCompletedeventfromscriptrunninginaWebpage,seetheBindingCompletedeventtopic.

CanUndoProperty

Trueifthereisapreviousactionthatcanbeundone.Read-onlyBoolean.

expression.CanUndo

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampleundoesthelastactionperformedordisplaysamessageboxiftheactioncannotbeundone.

SubUndo_Action()IfSpreadsheet1.CanUndoThenSpreadsheet1.UndoElseMsgBox"Can'tundolastaction."EndIfEndSub

CanUpdateProperty

ReturnsTrueiftheXmlDataBindingobject(asspecifiedbythe<Binding>elementintheXMLSpreadsheetfile)containsa<DataSource>elementwithaPurposeattribute(/Binding/DataSource/ConnectionInfo@Purpose)thathasthevalue"Update".OtherwiseitreturnsFalse.Read-only.

expression.CanUpdate

expressionRequired.AnexpressionthatreturnsanXmlDataBindingobject.

Remarks

NotethatanXMLDataBindingobjectcancontainmorethanone<DataSource>elementtag:oneinwhichPurposehasthevalue"Query"andoneinwhichPurposeis"Update".Forinformationonupdatebindings,seetheCanUpdateproperty.

AnXMLDataBindingobjectrepresentsabindingtoanXMLfile,aSOAPservice,anotherWebpart(onlywhenbindingfromaSpreadsheetWebPart),oradataretrievalserviceconnection.

TheXMLfragmentwherethedetailsappearintheXMLSpreadsheetfilelookssomethinglikethefollowing:

<udc:DataSourceMajorVersion="1"MinorVersion="0"xmlns:udc="http://schemas.microsoft.com/data/udc"><udc:TypeType="XMLFile"MajorVersion="1"MinorVersion="0"/><udc:Name>Example_Filename<udc:Name/><udc:ConnectionInfoPurpose="Update">...</udc:ConnectionInfo></udc:DataSource>

ExampleThefollowingexamplefirstdetermineswheteradataretrievalserviceconnectionbindingcanbeupdated(thatis,whetheritsPurposeattributehasthevalue"Update").Ifso,thecodecallstheUpdateBindingfunction,passingintheBindingIdattributevalueastheargument.Becauseupdatebindingsarealwaysperformedsynchronously,thereisnoneedtocheckifthebindingisasynchronous,andthefunctioncallstheUpdatemethodimmediately.

DimobjBinding

SetobjBinding=Spreadsheet1.ActiveWorkbook.XmlDataBindings("Cust_bind_id")IfobjBinding.CanUpdate=TrueThen'Fetchthedataandupdatethecorrespondingmap.UpdateBinding("Cust_bind_id")EndIfNext

FunctionUpdateBinding(strBindingID)DimobjBindingSetobjBinding=Spreadsheet1.ActiveWorkbook.XmlDataBindings(strBindingID)

objBinding.UpdateEndFunction

ShowAll

CaptionProperty

CaptionpropertyasitappliestotheChSeries,ChTitle,ChTrendline,Heading,Spreadsheet,PivotField,PivotFieldSet,PivotLabel,PivotMemberProperty,PivotTotal,andTitleBarobjects.

CaptionpropertyasitappliestotheChCategoryLabel,PivotAxisMember,PivotColumnMember,PivotMember,PivotPageMember,PivotResultMemberProperty,andPivotRowMemberobjects.

ExampleAsitappliestotheSpreadsheetobject.

ShowAll

CaptionHAlignmentProperty

ReturnsorsetsthehorizontalalignmentforthedetailfooterlabelinthespecifiedPivotTablelist.Read/writePivotHAlignmentEnum.

expression.CaptionHAlignment

expressionRequired.AnexpressionthatreturnsaPivotTotalobject.

RemarksCaptionscanbedisplayedonlytotheleftofaggregatesinthedetailfooter.UsetheCaptionHAlignmentpropertytoalignthecaptionclosetotheaggregate(plHAlignRight)ortoalignthecaptionclosetotheleftedgeofthefooter(plHAlignLeft).Ifthereisanotheraggregatedisplayedtotheleft,thecaptionisdisplayedtotherightoftheotheraggregate.Ifthereisnotenoughroomtodisplaythecaption,itisnotvisible.

ExampleThisexampleformatstotalsandtheircaptionsinthePivotTable1.

SubSet_Total_Alignment()DimptConstantsDimvwViewDimtotTotal

SetptConstants=PivotTable1.ConstantsSetvwView=PivotTable1.ActiveView'Loopthroughalltotalsintheview.ForEachtotTotalinvwView.DataAxis.Totals'Setthehorizontalalignmentofthetotaltocenter.totTotal.HAlignment=ptConstants.plHAlignCenter'Setthehorizontalalignmentofthecaptiontocenter.totTotal.CaptionHAlignment=ptConstants.plHAlignCenterNextEndSub

CaptionSectionProperty

Trueifthespecifiedgrouplevelhasacaptionsectionshowing.Read/writeBoolean.

expression.CaptionSection

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

RemarksThecaptionsectionappearsonadataaccesspageonlyonce,aboveallthevisiblerecordsatagivengrouplevel.Thecaptionsectionremainsvisibleasyouscrollthroughtherecords.

CategoryLabelsProperty

ReturnsthecollectionofChCategoryLabelsforthespecifiedaxis.Validonlyforcategoryandtimescaleaxes.

expression.CategoryLabels

expressionRequired.AnexpressionthatreturnsaChAxisobject.

CellProperty

ReturnsaPivotCellobjectthatindicatesthelocationoftheaggregatecellordetailcell.UsethispropertytoreturnmoreinformationabouttheselectedareainaPivotTablelist.

expression.Cell

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampleutilizestheDoubleClickeventofPivotTable1todisplaymoreinformationaboutacellinthedetailareaofthePivotTable.ThisexampleassumesthatPivotTable1isusingtheCustomerstableformtheNorthwinddatabase.

SubPivotTable1_DblClick()DimptSelectionDimnRowDimrs

SetptSelection=PivotTable1.Selection

'Ifthecurrentselectionisinthe'detailareaofthePivotTablelist.IfTypeName(ptSelection)="PivotDetailRange"then

nRow=ptSelection.TopLeft.Row

'Setavariabletotherecordsetofthetop-left'cellintheselection.Setrs=ptSelection.TopLeft.Cell.Recordset

'Movethecursorthethecorrectrecordintherecordset.rs.MovenRow

MsgBox"Therowthatwasdouble-clickedwas..."&String(2,vbCrLf)&_"CustomerID="&rs("CustomerID")&vbCrLf&_"CompanyName="&rs("CompanyName")&vbCrLf&_"ContactName="&rs("ContactName")ElseMsgBox"Double-clickonarow!",vbExclamation

EndIf

EndSub

ShowAll

CellsProperty

CellspropertyasitappliestotheRange,Spreadsheet,andWorksheetobjects.

CellspropertyasitappliestothePivotDataandPivotRangeobjects.

ExampleAsitappliestotheRange,Spreadsheet,andWorksheetobjects.

CellsExProperty

ReturnsaPivotCellobjectthatrepresentstheintersectionofthespecifiedrow,column,andpagemembers.

expression.CellsEx(Row,Column,Page)

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

RowRequiredPivotRowMemberobject.Specifiestherowcontainingthereturnedcell.

ColumnRequiredPivotColumnMemberobject.Specifiesthecolumncontainingthereturnedcell.

PageRequiredPivotPageMemberobject.Specifiesthepagecontainingthereturnedcell.

ExampleThisexamplesetsavariabletothetotalamountshippedvia2-Dayshippingtopostalcode28016inNorthCarolina.

SubGet2DayShippingToNC()

DimptDataDimpmRowMemberDimpmColMemberDimpmPageMemberDimpmIntersectionDimdblShipTotal

SetptData=PivotTable1.ActiveData

'Setavariabletoarowfieldmember.SetpmRowMember=ptData.RowAxis.Member.ChildAxisMembers("NorthCarolina")

'Setavariabletoacolumnfieldmember.SetpmColMember=ptData.ColumnAxis.Member.ChildAxisMembers("2-Day")

'Setavariabletoapagefieldmember.SetpmPageMember=ptData.PageAxis.Member.ChildAxisMembers("28016")

'Setavariabletotheintersectionoftherow,column,andpagefieldmembers.SetpmIntersection=ptData.CellsEx(pmRowMember,pmColMember,pmPageMember)

'Setavariabletothetotalshippingamountfortheitem.dblShipTotal=pmIntersection.Aggregates("Shipping").Value

EndSub

ChartDepthProperty

ReturnsorsetsaLongspecifyingthedepthofathree-dimensionalchartinrelationtoit'swidth.Settingthispropertytoavalueavaluegreaterthan100willmakeachartwhichisdeeperthanitiswide,whileavaluelessthan100willmakeachartwiderthanitisdeep.Validsettingsrangefrom0to500.Read/write.

expression.ChartDepth

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksThispropertyhasnoeffectona3-DPiechart.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthenincreasesthewidthanddepthofthechart.

SubFormat_3D_Depth_Width()

Dimcht3DColumn

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3DColumnchart.cht3DColumn.Type=chChartTypeColumnClustered3D

'Increasethedepthofthechartinrelation'toit'swidth.cht3DColumn.ChartDepth=125

'Increasethewidthofthechartinrelation'toit'sheight.cht3DColumn.AspectRatio=80

EndSub

ChartFieldsProperty

ReturnsaChChartFieldsobjectasthecollectionoffieldsthathavebeenaddedtothespecifieddropzone.

expression.ChartFields

expressionRequired.AnexpressionthatreturnsaChDropZoneobject.

ExampleThisexampledisplaysthenumberoffieldsthathavebeenaddedtotheseriesdropzoneinChartspace1.

SubSetupDropZone()

DimdzSeriesDropZoneDimChConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Displaythenumberoffieldsthathavebeenaddedtothe'seriesdropzone.MsgBoxdzSeriesDropZone.ChartFields.Count

EndSub

ShowAll

ChartLayoutProperty

Returnsorsetsthelayoutforallthechartsinthespecifiedchartworkspace.Read/writeChartChartLayoutEnum.

expression.ChartLayout

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

Becausethechartworkspacecancontainoneormorecharts,youcanuseboththeChartLayoutandChartWrapCountpropertiestospecifyhowmultiplechartsarepositioned.TheChartLayoutpropertymakesitpossibletocreatecustomchartarrangements,suchasthreechartspositionedhorizontallyinasinglerow.

Therearetwodistinctlayouttypesforcharts:

ChChartLayoutHorizontalChartsarepositionedhorizontallyfromlefttorightuntilthenumberofchartsspecifiedbytheChartWrapCountpropertyisreached.Whenthisoccurs,anewrowiscreatedbelowtheactiverowandthepositioningprocessbeginsagainattheleft.Thismethodcontinues(wrappingeveryChartWrapCountnumber)untilallchartshavebeenplaced.

ChChartLayoutVerticalChartsarepositionedverticallyfromtoptobottomuntilthenumberofchartsspecifiedbytheChartWrapCountpropertyisreached.Whenthisoccurs,anewcolumniscreatedtotherightoftheactivecolumnandpositioningbeginsagainatthetop.Thismethodcontinues(wrappingeveryChartWrapCountnumberofcharts)untilallchartshavebeenplaced.

ExampleThisexamplesetstheChartWrapCountandChartLayoutpropertiesandthenaddssixadditionalchartstothespecifiedchartworkspace.

SubAddCharts()DimchtChartDimchConstantsDimiCtrSetchConstants=ChartSpace1.Constants'Setthechartworkspacesothataroworcolumn'ofchartsiscreatedforeverytwocharts'inthechartworkspace.ChartSpace1.ChartWrapCount=2'Setthechartworkspacesothatthechartsarelaidourhorizontally.'Sincethiscodeaddssixchartstothechartworkspaceandthe'ChrtWrapCountpropertyhasbeensettowrapeverytwocharts,'thenthecoderesultsinthreerowsoftwocharts.ChartSpace1.ChartLayout=chConstants.chChartLayoutHorizontalForiCtr=1To6'Addacharttothechartworkspace.SetchtChart=ChartSpace1.Charts.Add'Enablethecharttitle.chtChart.HasTitle=True'Addatitletothechartthatindicatestheorder'inwhichthechartwascreated.

chtChart.Title.Caption="Chart#"&iCtr'Specifythatthechartistobealinechart.chtChart.Type=chConstants.chChartTypeLineNextEndSub

ChartsProperty

ReturnstheChChartscollectionforthespecifiedchartworkspace.

expression.Charts

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksBydefault,anewchartworkspacecontainsnocharts.Afteryoucreateanewchartworkspace,youmustaddaChartobjecttoitbeforeyoucancreateachart.UsetheAddmethodtocreateanewchart.

ExampleThisexampleaddsacharttothespecifiedchartworkspace.

Setcht=ChartSpace1.Charts.Add

ChartWrapCountProperty

Returnsorsetsthenumberofchartsthatareplacedhorizontallyorverticallybeforewrappingoccurs.Foramorecompletediscussionoflayoutandwrapping,seetheHelptopicfortheChartLayoutproperty.Read/writeLong.

expression.ChartWrapCount

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ExampleThisexamplesetstheChartWrapCountandChartLayoutpropertiesandthenaddssixadditionalchartstothespecifiedchartworkspace.

SubAddCharts()DimchtChartDimchConstantsDimiCtrSetchConstants=ChartSpace1.Constants'Setthechartworkspacesothataroworcolumn'ofchartsiscreatedforeverytwocharts'inthechartworkspace.ChartSpace1.ChartWrapCount=2'Setthechartworkspacesothatthechartsarelaidourhorizontally.'Sincethiscodeaddssixchartstothechartworkspaceandthe'ChrtWrapCountpropertyhasbeensettowrapeverytwocharts,'thenthecoderesultsinthreerowsoftwocharts.ChartSpace1.ChartLayout=chConstants.chChartLayoutHorizontalForiCtr=1To6'Addacharttothechartworkspace.SetchtChart=ChartSpace1.Charts.Add'Enablethecharttitle.chtChart.HasTitle=True'Addatitletothechartthatindicatestheorder'inwhichthechartwascreated.

chtChart.Title.Caption="Chart#"&iCtr'Specifythatthechartistobealinechart.chtChart.Type=chConstants.chChartTypeLineNextEndSub

CheckedProperty

Returnswhetherthespecifiedcommandisenabled.Read-onlyBoolean.

expression.Checked

expressionRequired.AnexpressionthatreturnsanOCCommandobject.

RemarksTheOCCommandId,ChartCommandIdEnum,PivotCommandId,andSpreadsheetCommandIdconstantscontainlistsofthesupportedcommandsforeachWebcomponent.

ChildAxisMembersProperty

ReturnsaPivotAxisMemberscollectionthatrepresentsthechildrenofthespecifiedPivotAxisMemberobject.

expression.ChildAxisMembers

expressionRequired.AnexpressionthatreturnsaPivotAxisMemberobject.

ExampleThisexamplesetsavariabletothetotalamountshippedvia2-Dayshippingtopostalcode28016inNorthCarolina.

SubGet2DayShippingToNC()

DimptDataDimpmRowMemberDimpmColMemberDimpmPageMemberDimpmIntersectionDimdblShipTotal

SetptData=PivotTable1.ActiveData

'Setavariabletoarowfieldmember.SetpmRowMember=ptData.RowAxis.Member.ChildAxisMembers

'Setavariabletoacolumnfieldmember.SetpmColMember=ptData.ColumnAxis.Member.ChildAxisMembers

'Setavariabletoapagefieldmember.SetpmPageMember=ptData.PageAxis.Member.ChildAxisMembers

'Setavariabletotheintersectionoftherow,column,andpagefieldmembers.SetpmIntersection=ptData.CellsEx(pmRowMember,pmColMember,pmPageMember)

'Setavariabletothetotalshippingamountfortheitem.dblShipTotal=pmIntersection.Aggregates("Shipping").Value

EndSub

ChildColumnMembersProperty

ReturnsaPivotColumnMemberscollectionthatrepresentsthechildrenofthespecifiedPivotColumnMemberobject.

expression.ChildColumnMembers

expressionRequired.AnexpressionthatreturnsaPivotColumnMemberobject.

ExampleThisexamplesetsavariabletothetotalamountshippedvia2-Dayshippingtopostalcode28016inNorthCarolina.

SubGet2DayShippingToNC()

DimptDataDimpmRowMemberDimpmColMemberDimpmPageMemberDimpmIntersectionDimdblShipTotal

SetptData=PivotTable1.ActiveData

'Setavariabletoarowfieldmember.SetpmRowMember=ptData.RowAxis.RowMember.ChildRowMembers("NorthCarolina")

'Setavariabletoacolumnfieldmember.SetpmColMember=ptData.ColumnAxis.ColumnMember.ChildColumnMembers

'Setavariabletoapagefieldmember.SetpmPageMember=ptData.PageAxis.PageMember.ChildPageMembers("28016")

'Setavariabletotheintersectionoftherow,column,andpagefieldmembers.SetpmIntersection=ptData.CellsEx(pmRowMember,pmColMember,pmPageMember)

'Setavariabletothetotalshippingamountfortheitem.dblShipTotal=pmIntersection.Aggregates("Shipping").Value

EndSub

ChildLabelProperty

GetsorsetsthevalueoftheIDattributeofthelabelassociatedwithacontrol.Read/writeString.

expression.ChildLabel

expressionRequired.AnexpressionthatreturnsanElementExtensionobject.

ChildMembersProperty

ReturnsaPivotMemberscollectionthatrepresentsthechildmembersofthespecifiedmember.

expression.ChildMembers

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ChildPageMembersProperty

ReturnsaPivotPageMemberscollectionthatrepresentsthechildrenofthespecifiedPivotPageMemberobject.

expression.ChildPageMembers

expressionRequired.AnexpressionthatreturnsaPivotPageMemberobject.

ExampleThisexamplesetsavariabletothetotalamountshippedvia2-Dayshippingtopostalcode28016inNorthCarolina.

SubGet2DayShippingToNC()

DimptDataDimpmRowMemberDimpmColMemberDimpmPageMemberDimpmIntersectionDimdblShipTotal

SetptData=PivotTable1.ActiveData

'Setavariabletoarowfieldmember.SetpmRowMember=ptData.RowAxis.RowMember.ChildRowMembers("NorthCarolina")

'Setavariabletoacolumnfieldmember.SetpmColMember=ptData.ColumnAxis.ColumnMember.ChildColumnMembers("2-Day")

'Setavariabletoapagefieldmember.SetpmPageMember=ptData.PageAxis.PageMember.ChildPageMembers

'Setavariabletotheintersectionoftherow,column,andpagefieldmembers.SetpmIntersection=ptData.CellsEx(pmRowMember,pmColMember,pmPageMember)

'Setavariabletothetotalshippingamountfortheitem.dblShipTotal=pmIntersection.Aggregates("Shipping").Value

EndSub

ChildRowMembersProperty

ReturnsaPivotRowMemberscollectionthatrepresentsthechildrenofthespecifiedPivotRowMemberobject.

expression.ChildRowMembers

expressionRequired.AnexpressionthatreturnsaPivotRowMemberobject.

ExampleThisexamplesetsavariabletothetotalamountshippedvia2-Dayshippingtopostalcode28016inNorthCarolina.

SubGet2DayShippingToNC()

DimptDataDimpmRowMemberDimpmColMemberDimpmPageMemberDimpmIntersectionDimdblShipTotal

SetptData=PivotTable1.ActiveData

'Setavariabletoarowfieldmember.SetpmRowMember=ptData.RowAxis.RowMember.ChildRowMembers

'Setavariabletoacolumnfieldmember.SetpmColMember=ptData.ColumnAxis.ColumnMember.ChildColumnMembers("2-Day")

'Setavariabletoapagefieldmember.SetpmPageMember=ptData.PageAxis.PageMember.ChildPageMembers("28016")

'Setavariabletotheintersectionoftherow,column,andpagefieldmembers.SetpmIntersection=ptData.CellsEx(pmRowMember,pmColMember,pmPageMember)

'Setavariabletothetotalshippingamountfortheitem.dblShipTotal=pmIntersection.Aggregates("Shipping").Value

EndSub

ChildSectionProperty

ReturnsaSectionobjectthatrepresentsthechildsectionforthespecifiedsection.Thispropertyfailsifthespecifiedsectionisnotexpanded.

expression.ChildSection

expressionRequired.AnexpressionthatreturnsaSectionobject.

ColorProperty

Returnsorsetstheprimarycolorofthespecifiedobject.Read/writeVariant.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

Oncharts,youcanalsouseeitherofthefollowingtwospecialconstants:chColorAutomatic(toresetthecolortothedefaultvalue)orchColorNone(toindicatenocolor,ortransparency).However,youcannotsetafontcolortochColorNone.

ExampleThisexampleaddsamedium-weightgreenbordertoallcellsintherangeB5:C10onthespreadsheet.

SubSetBorder()

SetssConstants=Spreadsheet1.ConstantsSpreadsheet1.ActiveSheet.Range("b5:c10").Borders.Weight=ssConstants.owcLineWeightMediumSpreadsheet1.ActiveSheet.Range("b5:c10").Borders.Color="green"EndSub

ShowAll

ColorIndexProperty

ColorIndexpropertyasitappliestotheBorderobject.

ColorIndexpropertyasitappliestotheBordersobject.

ColorIndexpropertyasitappliestotheFontobject.

ColorIndexpropertyasitappliestotheInteriorobject.

RemarksThispropertyspecifiesacolorasanindexintotheworkbookcolorpalette.YoucanusetheColorsmethodtoreturnthecurrentcolorpalette.

Thefollowingillustrationshowsthecolor-indexvaluesinthedefaultcolorpalette.

ExampleAsitappliestotheFontobject.

ColorsProperty

Returnsorsetscolorsinthepalettefortheworkbook.Thepalettehas56entries,eachrepresentedbyanRGBvalue.Read/writeVariant.

expression.Colors(Index)

expressionRequired.AnexpressionthatreturnsaWorkbookobject.

IndexOptionalVariant.Thecolornumber(from1to56).Ifthisargumentisn’tspecified,thismethodreturnsanarraythatcontainsall56ofthecolorsinthepalette.

ExampleThisexamplesetscolorfiveinthecolorpalettefortheactiveworkbook.

Spreadsheet1.ActiveWorkbook.Colors(5)=RGB(255,0,0)

ThisexamplecreatesatableontheactiveworksheetinSpreadsheet1thatdisplaystheavailablecolorpalette.

SubCreate_Color_Table()DimavarColorArray()DimiCtrDimrngCurrent

'Setanarrayvariabletothecolorsinthecolorpalette.avarColorArray=Spreadsheet1.ActiveWorkbook.Colors

SetrngCurrent=Spreadsheet1.ActiveSheet.Range("A1")

'Loopthroughallofthecolorsinthearray.ForiCtr=1ToUBound(avarColorArray)rngCurrent.Value="Color"&iCtr

'SetthecolorofacellincolumnBto'theappropriatecolor.rngCurrent.Offset(0,1).Interior.Color_=avarColorArray(iCtr)

SetrngCurrent=rngCurrent.Offset(1,0)NextEndSub

ColumnProperty

Returnsthenumberofthefirstcolumninthespecifiedrange.Read-onlyLong.

expression.Column

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsthefonttoboldineveryothercolumnofthevisiblerangeontheactiveworksheet.

SubBoldColumns()Dimcol

ForEachcolInSpreadsheet1.ActiveSheet.VisibleRange.ColumnsIfcol.ColumnMod2=0Thencol.Font.Bold=TrueNextEndSub

ColumnAxisProperty

PivotDataobject:ReturnsaPivotResultColumnAxisobjectthatrepresentsthecolumnaxisinthespecifiedPivotTablelist.

PivotViewobject:ReturnsaPivotGroupAxisobjectthatrepresentsthecolumnaxisinthespecifiedPivotTablelist.

expression.ColumnAxis

expressionRequired.AnexpressionthatreturnsaPivotDataorPivotViewobject.

ExampleThisexampleinsertstwofieldsetsintothePivotTablelistintheactiveview.

SubAddFieldsToPT()

DimptView

SetptView=PivotTable1.ActiveView

ptView.ColumnAxis.InsertFieldSetptView.FieldSets("StoreType")

ptView.RowAxis.InsertFieldSetptView.FieldSets("Promotions")

EndSub

ColumnHeadingsProperty

ReturnsaHeadingscollectionthatrepresentsthecolumnheadingsinthespecifiedwindow.UsetheCaptionpropertytocustomizethecolumnheadings.

expression.ColumnHeadings

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplesetsthecreatesacustomdataentrysheetbydisablingsomeuserinterfaceelements,limitingtheviewablerangeintheactivewindow,andcustomizingtherowandcolumnheadings.

SubCreate_Datasheet()DimhdrColHeadingsDimhdrRowHeadingsDimwndActive

SetwndActive=Spreadsheet1.ActiveWindow

'HidevariousUIelements.wndActive.DisplayWorkbookTabs=FalseSpreadsheet1.DisplayToolbar=False

'Displaythetitlebarandsetit'scaption.Spreadsheet1.DisplayTitleBar=TrueSpreadsheet1.TitleBar.Caption="RevenueWorksheet"

'Resizethespreadsheetcomponent.Spreadsheet1.AutoFit=True

'Limittheviewablerangeoftheactivesheet.wndActive.ViewableRange="A1:D5"

'Setavariabletothecolumnheadingsintheactivewindow.SethdrColHeadings=wndActive.ColumnHeadings

'Setavariabletotherowheadingsintheactivewindow.SethdrRowHeadings=wndActive.RowHeadings

'SettheheadingsofcolumnsAthroughD.hdrColHeadings(1).Caption="Qtr1"hdrColHeadings(2).Caption="Qtr2"hdrColHeadings(3).Caption="Qtr3"hdrColHeadings(4).Caption="Qtr4"

'Settheheadingsofrows1though5.hdrRowHeadings(1).Caption="1996"hdrRowHeadings(2).Caption="1997"hdrRowHeadings(3).Caption="1998"hdrRowHeadings(4).Caption="1999"hdrRowHeadings(5).Caption="2000"EndSub

ColumnMemberProperty

ReturnsaPivotColumnMemberobjectthatrepresentstheinnermostmemberonthecolumnaxisthatintersectsthespecifiedcell.

expression.ColumnMember

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ColumnMembersProperty

ReturnsaPivotColumnMemberscollectionthatrepresentsallthemembersofthespecifiedcolumn.

expression.ColumnMembers

expressionRequired.AnexpressionthatreturnsaPivotRangeobject.

RemarksThecollectionofcolumnmembersdoesnotincludeanymembersthatyouhavefilteredbysettingtheirIsFilteredpropertytoTrue.

ShowAll

ColumnsProperty

ColumnpropertyasitappliestotheRangeobject.

ColumnpropertyasitappliestotheSpreadsheetandWorksheetobjects.

ExampleAsitappliestotheRangeobject.

AsitappliestotheWorksheetobject.

ColumnWidthProperty

Returnsorsetsthewidthofallcolumnsinthespecifiedrange.ReturnsNullifthecolumnsintherangearenotallthesamewidth.UsetheIsNullfunctiontodeterminewhetherthereturnvalueisNull.Read/writeVariant.

expression.ColumnWidth

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplesetstheformula,columnwidth,andnumberformatforallthecellsintherangeA1:F10ontheactiveworksheet.

SubFormat_Sheet1()DimrngCurrentSetrngCurrent=Spreadsheet1.ActiveSheet.Range("A1:F10")rngCurrent.Formula="=rand()"rngCurrent.ColumnWidth=10rngCurrent.NumberFormat="#.###"EndSub

CommandsProperty

ReturnsanOCCommandsobjectthatrepresentsthecollectionofcommandsavailable.

expression.Commands

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

CommandTextProperty

Returnsorsetsthecommandstringforthespecifiedobject.Read-onlyStringfortheRecordsetDefandSchemaRowsourceobjects;read/writeStringforallotherobjectsintheAppliesTolist.

expression.CommandText

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksFortypedscCommandText,thispropertyreturnsorsetsatextstring(usuallySQL)thatreturnsasingleresultsetfromtheprovider.

FortypedscCommandFile,thispropertyreturnsorsetstheURLofanXMLfilecontainingdataforthespecifiedSchemaRowsourceobject.

ShowAll

CompareMemberCaptionsByProperty

ReturnsorsetsaPivotMembersCompareByEnumconstantthatdetermineshowthePivotTablecontrolcomparesmembercaptionstothelistofcustomcaptionssetbytheMemberCaptionsproperty.CaptionsthatmatchthecustomlistestablishedbytheMemberCaptionspropertyarerenamedusingthecustomcaption.Read/write.

expression.CompareMemberCaptionsBy

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

RemarksThedefaultsettingwhenthespecifiedfieldsetisatime-basedfieldisplMembersCompareByName.Otherwise,thedefaultsettingisplMembersCompareByUniqueName.

ShowAll

CompareOrderedMembersByProperty

ReturnsorsetsaPivotMembersCompareByEnumconstantthatdetermineshowthePivotTablecontrolsortsmembersofthespecifiedfieldsetwhenacustomsortorderhasbeenestablishedbytheOrderedMembersproperty.Read/write.

expression.CompareOrderedMembersBy

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

RemarksThedefaultsettingwhenthespecifiedfieldsetisatime-basedfieldisplMembersCompareByName.Otherwise,thedefaultsettingisplMembersCompareByUniqueName.

ConnectionProperty

ReturnsorsetstheADOConnectionobjectusedbythespecifiedobject.Read/writeforthePivotTableobject;read-onlyfortheDataSourceControlandDSCEventInfoobjects.

expression.Connection

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksUsecautionwhencallingmethodsorsettingpropertiesfortheConnectionobjectreturnedbythisproperty.Forexample,youshouldnotcalltheConnectionobject'sClosemethod.

ImportantForinformationaboutsecuredataconnections,seeMakingConnectionstoExternalDataSourcesMoreSecure.

ConnectionFileProperty

ReturnsorsetsaStringthatspecifiestheOfficeDatabaseConnection(.odc)orMicrosoftDataLink(.udl)filethatisusedtoconnectthedataaccesspagetoadatasource.Read/write.

expression.ConnectionFile

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ExampleThisexampleconnectsthedataaccesspagetoaOfficeDatabaseConnectionfilenamed"SQLNorthwind.odc".

MSODSC.ConnectionFile="SQLNorthwind.odc"

ConnectionStringProperty

ReturnsorsetstheADOconnectionstringforatwo-tierdatabaseconnection.Read/writeString.

expression.ConnectionString

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksWiththedatasourcecontrol,thispropertyisequivalenttoCurrentProject.BaseConnectionStringinMicrosoftAccess.Whenthedatasourcecontrolcreatesaconnection,thevalueofthedatasourcecontrolConnectionStringpropertymaynotbethesameasthevaluereturnedbytheConnectionStringpropertyoftheConnectionobjectbecausethedatasourcecontrolusesotherOLEDBproviderstosupplyadditionalservices.Forexample,onanHTMLpagecontainingadatasourcecontrolwithID"MSODSC"thefollowingexpressionsmaynotbeequivalent.

ImportantForinformationaboutsecuredataconnections,seeMakingConnectionstoExternalDataSourcesMoreSecure.

MSODSC.ConnectionStringMSODSC.Connection.ConnectionString

ExampleThisexampleestablishesaconnectiontoadatabase,queriesthedata,andthenaddsfieldstoPivotTable1whentheWebpagecontainingthePivotTable1isloaded.

SubWindow_OnLoad()

DimsConnStrDimptView'Setavariabletotheconnectionstring.sConnStr="Provider=sqloledb;DataSource=DataServer;InitialCatalog=Testing;IntegratedSecurity=SSPI;"'SettheconnectionstringPivotTable1.ConnectionString=sConnStr

'ReturnalldatafromtheSpendingtable.PivotTable1.CommandText="Select*fromSpending"SetptView=PivotTable1.ActiveView'Thefollowingfourlinesofcodeaddfieldstotherowareaanddata'areasofthePivotTablelist.ptView.RowAxis.InsertFieldSetptView.FieldSets("Project")ptView.RowAxis.InsertFieldSetptView.FieldSets("Year")ptView.DataAxis.InsertFieldSetptView.FieldSets("Budget")ptView.DataAxis.InsertFieldSetptView.FieldSets("Actual")

EndSub

ConstantsProperty

Returnsanobjectthatallowsscriptuserstousenamedconstants.Read-only.

Formoreinformation,seeUsingNamedConstantsinVBScript.

ThispropertyisrequiredonlyonHTMLpages.Inothercontainers(suchasVisualBasic),youcanusedefinedconstantsfromtheobjectmodeldirectly,withoutfirstusingtheConstantsproperty.UsingtheConstantspropertyinothercontainerswillworkbutisnotrecommended,asitwillcauseyourcodetorunsignificantlyslower.

expression.Constants

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampleaddsamedium-weightgreenbordertoeachcellintherangeB5:C10onthespreadsheet.BecausenamedconstantsarenotavailableinVBScript,theexamplesetsavariabletotheobjectreturnedbytheConstantsproperty.

SubSetBorder()DimssConstants'SetavariabletotheconstantsoftheSpreadsheetcomponent.SetssConstants=Spreadsheet1.Constants'Settheborderweight.Spreadsheet1.Range("b5:c10").Borders.Weight=ssConstants.owcLineWeightMedium'Setthebordercolor.Spreadsheet1.Range("b5:c10").Borders.Color="green"EndSub

ConsumesRecordsetProperty

Trueforcomplexcontrolsifdataissuppliedbythedatasourcecontrol.Anydata-boundcontrolhaseitheraControlSourceproperty(usedwithasimpleHTMLcontrol)oraConsumesRecordsetproperty(usedwithacomplexcontrolsuchasaPivotTablelistorchartworkspace).Read/writeBoolean.

expression.ConsumesRecordset

expressionRequired.AnexpressionthatreturnsanElementExtensionobject.

ControlProperty

ReturnsaPivotTableobjectthatrepresentsthePivotTablelistforthespecifiedPivotDataorPivotViewobject.

expression.Control

expressionRequired.AnexpressionthatreturnsaPivotDataorPivotViewobject.

ControlSourceProperty

Returnsorsetsthenameofthecontroltowhichthespecifiedcontrolisbound.Read/writeString.

expression.ControlSource

expressionRequired.AnexpressionthatreturnsanElementExtensionobject.

RemarksThispropertyreturnsorsetsthevaluesoftheNameandSourcepropertiesforthefieldtowhichthespecifiedcontrolisbound.Thepropertyvaluesarereturnedasastringinthefollowingformat:"PageField.Name:PageField.Source"wherethestringsinitalicsarereplacedwiththeactualvaluesoftheNameandSourceproperties.IftheNameandSourcepropertyvaluesareidentical,onlyonevalueisreturned.

Ifyousetthispropertytothenameofaschemafieldinaschemarowsourceusedbythesectioncontainingthespecifiedcontrol,theschemafieldisautomaticallyaddedasapagefield.

CountProperty

Returnsthenumberofobjectsinthespecifiedcollection.Read-onlyLong.

expression.Count

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsvariablestothenumberofcolumnsandthenumberofrowsinthevisiblerangeontheactiveworksheet,andthenformatsthecolorofthecellsineveryotherrow.

SubFormat_Odd_Rows()DimrngUsedDimiUsedRowsDimiUsedColumnsDimshtActiveDimiCtrSetshtActive=Spreadsheet1.ActiveSheet'Setavariableottheusedrangeoftheactivesheet.SetrngUsed=shtActive.UsedRange'Getthecountofusedrowsintheactivesheet.iUsedRows=rngUsed.Rows.Count'Getthecountofusedcolumnsintheactivesheet.iUsedColumns=rngUsed.Columns.Count'Loopthrougheveryoddrowintheusedrange.ForiCtr=1ToiUsedRowsStep2'Colorthebackgroundofthecellsgreen.shtActive.Range(shtActive.Cells(iCtr,1),shtActive._Cells(iCtr,iUsedColumns)).Interior.ColorIndex=43NextEndSub

CriteriaProperty

ReturnstheCriteriaobjectforthespecifiedfilter.UsetheAddmethodoftheCriteriaobjectreturnedbythispropertytoaddcriteriatoaFilterobject.Read-only.

expression.Criteria

expressionRequired.AnexpressionthatreturnsaFilterobject.

ExampleThisexampleturnsontheAutoFilterfortherangeA1:C20,setsfiltersforcolumnsAandC,andthenappliesthefilters.

SubApply_AutoFilter()DimafFiltersDimafCol1DimafCol3

'TurnonAutoFilter.Spreadsheet1.Worksheets("Sheet1").Range("A1:C20").AutoFilter

'SetavariabletotheAutoFilterobjectSetafFilters=Spreadsheet1.Worksheets("sheet1").AutoFilter

SetafCol1=afFilters.Filters(1)SetafCol3=afFilters.Filters(3)

'AddacriteriathatexcludesbluefromcolumnA.afCol1.Criteria.Add"blue"

'AddacriteriathatexcludesgreenfromcolumnA.afCol1.Criteria.Add"green"

'Addacriteriathatexcludesyellowfromcolumnc.afCol3.Criteria.Add"yellow"

'ApplythecriteriaafFilters.ApplyEndSub

ShowAll

CrossesProperty

Returnsorsetsavaluethatindicateshowthespecifiedaxiscrossesanotheraxis.Read/writeChartAxisCrossesEnum.

expression.Crosses

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetsthecategoryaxistocrossthevalueaxisatvaluezero(0)inthechartworkspaceifacustomcrossingpointhasnotalreadybeensetforthecategoryaxis.

SubFormat_Axis()DimchConstantsDimaxValueAxisDimaxCategoryAxis

SetchConstants=ChartSpace1.ConstantsSetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)SetaxCategoryAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory)IfaxCategoryAxis.Crosses=chConstants.chAxisCrossesAutomaticThenaxValueAxis.CrossingAxis=axCategoryAxisaxCategoryAxis.CrossesAtValue=0EndIf

EndSub

CrossesAtValueProperty

Returnsorsetsthecrossingpointforthespecifiedaxis.Whenyousetthisvalueforanaxis,youaresettingthevalueontheotheraxiswheretheaxisyouaresettingwillcrossthatotheraxis.Forexample,settingthispropertyonthevalue(y)axissetsthecategorynumberwherethevalueaxiswillcrossthecategory(x)axis.Read/writeDouble.

expression.CrossesAtValue

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetsthecategoryaxistocrossthevalueaxisatvaluezero(0)inthechartworkspace.

SubSetCrossingValue()DimchConstantsDimaxValueAxisDimaxCategoryAxisSetchContants=ChartSpace1.ConstantsSetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)SetaxCategoryAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory)axValueAxis.CrossingAxis=axCategoryAxisaxCategoryAxis.CrossesAtValue=0EndSub

Thefollowingexamplecausesthevalueaxistocrossthecategoryaxisatthethirdcategory.

SubSetCrossingCategory()DimchConstantsSetchConstants=ChartSpace1.ConstantsChartSpace1.Charts(0).Axes(chConstants.chAxisPositionLeft).CrossesAtValueEndSub

CrossingAxisProperty

Returnsorsetsthecrossingaxis.Ifthespecifiedaxisisdeleted,thispropertyissettoNull,andtheCrossespropertyisresettochAxisCrossesAutomatic.Read/writeChAxis.

expression.CrossingAxis

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetsthecategoryaxistocrossthevalueaxisatvaluezero(0)inthechartworkspace.

SubSetCrossingValue()DimchConstantsDimaxValueAxisDimaxCategoryAxisSetchtContants=ChartSpace1.ConstantsSetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)SetaxCategoryAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory)axValueAxis.CrossingAxis=axCategoryAxisaxCategoryAxis.CrossesAtValue=0EndSub

CSVDataProperty

Returnsorsetsspreadsheetdataasacomma-delimitedlist.Read/writeString.

expression.CSVData

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexamplesetsthevaluesforcellsA1:G1.

Spreadsheet1.CSVData="1,1,2,3,5,8,13"

CSVURLProperty

ReturnsorsetstheURL(Internetaddress)forthecomma-delimitedspreadsheetdatafile.Read/writeString.

expression.CSVURL

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexamplesetsspreadsheetdatafromafileontheuser'scomputer.

Spreadsheet1.CSVURL="file:\test.csv"

CurrentArrayProperty

Ifthespecifiedcellispartofanarray,returnsaRangeobjectthatrepresentstheentirearray.Resultsinarun-timeerrorifthespecifiedcellisnotpartofanarray.Read-only.

expression.CurrentArray

expressionRequired.AnexpressionthatreturnsaRangeobject.

RemarksUsetheHasArraypropertytodeterminewhetherornotacellispartofanarray.

ExampleAssumingthattheactivecellispartofanarray,thisexampleselectsthearray.

Spreadsheet1.ActiveCell.CurrentArray.Select

CurrentCellProperty

ReturnsaPivotCellobjectthatcontainsthedetailcellthatiscurrentlybeingedited.

expression.CurrentCell

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

RemarksThispropertyisrelevantonlywhenthePivotTablelistisconnectedtoarelationaldatasource.

CurrentRegionProperty

ReturnsaRangeobjectthatrepresentsthecurrentregion.Thecurrentregionisarangeboundedbyanycombinationofblankrowsandblankcolumns.Read-only.

expression.CurrentRegion

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThefunctioninthisexamplereturnsTrue,iftheentirecurrentregionforcellA1ontheactiveworksheetisvisible(ifthecurrentregionextendsoutsidethevisiblerange,thefunctionreturnsFalse).

FunctionIsCurrentRegionVisible()DimrngCurrentDimrngVisibleDimrngIntersect

'SetthevaribletothecurrentregionofcellA1.SetrngCurrent=Spreadsheet1.ActiveSheet.Cells(1,1).CurrentRegion

'Setavariabletothecurrentlyvisiblerange.SetrngVisible=Spreadsheet1.ActiveWindow.VisibleRange'Setavariabletotheoverlappingportionofthecurrentregion'andthevisiblerange.SetrngIntersect=Spreadsheet1.RectIntersect(rngCurrent,rngVisible)

'Iftheoverlappingregionisthesameasthecurrentregion,then'returntrue.IsCurrentRegionVisible=(rngIntersect.Address=rngCurrent.Address)EndFunction

CurrentSectionProperty

ReturnsaSectionobjectthatrepresentsthecurrentsection(thesectioncontainingthecontrolthatcurrentlyhasthefocus).

expression.CurrentSection

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

CustomGroupMembersProperty

ReturnsaPivotMemberscollectionthatrepresentsthemembersofacustomgroupfield.

expression.CustomGroupMembers

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ShowAll

CustomGroupTypeProperty

ReturnsaPivotMemberCustomGroupTypeEnumconstantthatrepresentsthetypeofgroupthatthespecifiedmemberisincludedin.Read-only.

expression.CustomGroupType

expressionRequired.AnexpressionthatreturnsaPivotAxisMemberobject.

ShowAll

DashStyleProperty

ReturnsorsetsaChartLineDashStyleEnumconstantindicatingthedashstyleforthespecifiedlineorborder.Read/write.

expression.DashStyle

expressionRequired.AnexpressionthatreturnsaChLineorChBorderobject.

RemarksThispropertyisvalidonlyforserieslines.

ExampleThisexamplechangesthefirstchartinChartspace1toalinechartandthenformatsthelineforthefirstdataseriesinthechart.

SubSet_Series_LineStyle()

DimchConstantsDimserSeries1

SetchConstants=ChartSpace1.Constants

'Changethecharttoalinechart.ChartSpace1.Charts(0).Type=chChartTypeLine

'Setavariabletorefertothefirstdataseriesinthechart.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Setthemiterofthelineofthefirstseries.serSeries1.Line.Miter=chConstants.chLineMiterBevel

'Setthelineweightofthefirstseries.serSeries1.Line.Weight=chConstants.owcLineWeightThick

'Setthelinestyleofthefirstseries.serSeries1.Line.DashStyle=chConstants.chLineRoundDot

EndSub

DataProperty

ReturnsaPivotDataobjectthatrepresentsthesourcedataforthePivotTablelist.

expression.Data

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

DataAxisProperty

ReturnsaPivotDataAxisobjectthatrepresentsthedataaxis.UsethePivotDataAxisobjectreturnedbythispropertytoinsertfieldsandtotalsonthedataaxisofaPivotTablelist.Read-only.

ExampleThisexampleaddsatotaltothePivotTablelistintheactiveviewandinsertsafieldsetonthedataaxis.

SubInsertTotal()DimptViewDimptConstantsDimtotNewtotalSetptView=PivotTable1.ActiveViewSetptConstants=PivotTable1.Constants

SettotNewTotal=view.AddTotal("myTotal",view.FieldSets("Freight").Fields(0),_ptConstants.plFunctionSum)ptView.DataAxis.InsertTotaltotNewTotalptView.DataAxis.InsertFieldSetptView.FieldSets("OrderDate")EndSub

DataBodyRangeProperty

ReturnsthedataboundrowsfromaspecifiedListObjectobjectasaRangeobject.Read-onlyRange.

expression.DataBodyRange

expressionRequired.AnexpressionthatreturnsaListObjectobject.

Remarks

SomeRangepropertiesandmethodsarenotsupported.ThepropertiesnotsupportedareLocked,MergeAreaandMergeCells.ThemethodsnotsupportedareDelete,Insert,Merge,andUnMerge.TheDataBodyRangedoesnotincludetheHeaderRowRangeproperty(theheaderrowabovethedataboundrows)ortheInsertRowRangeproperty(theinsertrowbelowthedataboundrows).

Notethatifyouwanttosetcolorsonrows,youcanonlydosoonentirerowswithintheXMLlist.Youcannotsetthecoloroftheinsertrow.

ExampleThisexamplesetstheinteriorcoloroftheDataBodyRangeofaListObjectobjecttoyellowandthebordercolortored.

DimrngDataBody'Setavariabletothedatabodyrange.SetrngDataBody=Spreadsheet1.ActiveSheet.ListObjects(1).DataBodyRange'Settheinteriorcolorandthebordercolorofthedatabodyrange.WithrngDataBody.Interior.ColorIndex=6.Borders.ColorIndex=3EndWith

DataEntryProperty

Trueifthespecifiedpageisusedonlyfordataentry(Falseifthepageincludesapopulatedrecordset).ThedefaultvalueisFalse.Read/writeBoolean.

expression.DataEntry

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

DataFieldProperty

ReturnsthenameofthefieldthatthePivotFieldobjectisboundtoifthedataiscomingfromarecordset.Read-onlyString.

expression.DataField

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

DataLabelProperty

ReturnsaChDataLabelobjectthatrepresentsthedatalabelassociatedwiththespecifiedtrendline.Read-only.

expression.DataLabel

expressionRequired.AnexpressionthatreturnsaChTrendlineobject.

ExampleThisexampleaddsatrendlinetothespecifiedseriesinthechartworkspace,setsthefontforthedatalabeltobold,andcausesthetrendlinetodisplayonlyitsequation(theR-squaredvalueisnotdisplayed).

SubAddTrendLine()Dimtrndline

'AddatrendlinetothefirstseriesinthefirstchartinChartSpace1.Settrndline=ChartSpace1.Charts(0).SeriesCollection(0).Trendlines.Add

'Setthefontofthetrendlinetobold.trndline.DataLabel.Font.Bold=True

'DonotdisplaytheR-Squaredvaluewiththetrendline.trndline.IsDisplayingRSquared=False

'Displaytheequationforthetrendline.trndline.IsDisplayingEquation=TrueEndSub

DataLabelsCollectionProperty

ReturnsaChDataLabelsCollectionobjectthatcontainsthedatalabelsforthespecifiedseries.Eachseriescancontainonlyonesetofdatalabels.Read-only.

Formoreinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

expression.DataLabelsCollection

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

ExampleThisexampleaddsdatalabelstothespecifiedseriesinthechartworkspace.

ChartSpace1.Charts(0).SeriesCollection(0).DataLabelsCollection.Add

Thisexamplesetsthefontforthedatalabelsforthespecifiedseries.

ChartSpace1.Charts(0).SeriesCollection(0).DataLabelsCollection(0).Font.Bold=True

DataMemberProperty

Returnsorsetsthedatamembername(thenameoftherecordsetthatthespecifiedcontrolwillrequestfromthedatasource).Read/writeDataMember.

expression.DataMember

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

DataPageProperty

ReturnsaDataPageobjectthatrepresentsthedataaccesspageforthespecifiedsection.

expression.DataPage

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksAdatapageisaclusterofsectionsthatshareacommonrecordnavigationcontrol.

DataPagesProperty

ReturnstheDataPagescollectionforthedatasourcecontrol.

expression.DataPages

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

DataPageSizeProperty

Returnsorsetsthenumberofrecordsshownforthespecifiedbandinglevelonadataaccesspage.Thedefaultvalueis5forabandedpageand1foranon-bandedpage.Read/writeLong.

expression.DataPageSize

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

DataSourceProperty

ReturnsorsetstheADODataSourceobjectthatrepresentsthedatasourceforthespecifiedcontrol.

expression.DataSource

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplecreatesachartthatisboundtoaspreadsheet.TheseriesnameisincellB1,thecategorynamesareincellsA2:A28,andthevaluesareincellsB2:B28.

Setc=ChartSpace1.ConstantsSetChartSpace1.DataSource=Spreadsheet1.ObjectChartSpace1.Charts.AddChartSpace1.Charts(0).Type=c.chChartTypeLineMarkersChartSpace1.Charts(0).SetDatac.chDimCategories,0,"a2:a28"ChartSpace1.Charts(0).SetDatac.chDimSeriesNames,0,"b1"ChartSpace1.Charts(0).SeriesCollection(0).SetDatac.chDimValues,0,"b2:b28"

DataSourceNameProperty

ReturnsorsetsaStringspecifyingthenameoftheActiveXcontrolthatservesasthedatasourceforthechartcontrol.ThispropertycanbeusedincontainersthatsupporttheMicrosoftInternetExplorerDocumentObjectModel.Read/write.

expression.DataSourceName

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ExampleThisexampleestablishesPivotTable1asthedatasourceforChartspace1andthendisplaysthefieldlistsothattheusercanadddatatothechart.

SubConnectChart()

'BindChartSpace1toPivotTable1.Chartspace1.DataSourceName="PivotTable1"

'Displaythefieldlist.Chartspace1.DisplayFieldList=True

EndSub

ShowAll

DataSourceTypeProperty

Returnsorsetsthedatasourcetypeforthespecifiedchartworkspace.Read-onlyChartDataSourceTypeEnum.

expression.DataSourceType

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ShowAll

DataTypeProperty

DataTypepropertyasitappliestotheSchemaFieldandSchemaParameterobjects.

DataTypepropertyasitappliestothePivotFieldobject.

DataTypepropertyasitappliestotheSpreadsheetobject.

DefaultColorProperty

ReturnsaRGB-packedintegerthatrepresentsthespecifiedfillcolorwhentheColorpropertyischColorAutomatic.Read-onlyVariant.

expression.DefaultColor

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

ShowAll

DefaultControlTypeProperty

Returnsorsetsthedefaultcontroltypeforthespecifieddatasourcecontrol.Read/writeDefaultControlTypeEnum.

expression.DefaultControlType

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

DefaultMemberProperty

ReturnsaPivotMemberobjectthatrepresentsthedefaultmemberforthespecifiedfieldset.

expression.DefaultMember

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

RemarksThispropertyisvalidonlywhenthePivotTablelistisconnectedtoanOLAPdatasource.

ThedefaultmemberisusuallyAlloroneofthetopmembersinthedimension.

DefaultQueryOnLoadProperty

WhenthispropertyissettoTrue,bindingsthathaveaPurposeattributewiththevalue"Query"andaLoadModeattributewiththevalue"Normal"willrefreshwhenthepageloads.WhensettoFalse,nobindingsarerefreshedwhenthepageisloaded.Read/write.

expression.DefaultQueryOnLoad

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

Remarks

AnXmlDataBindingobjectcanbeabindingtoanXMLfile,aSOAPservice,anotherWebPart(onlywhenbindingfromaSpreadsheetWebPart),oradataretrievalservice.

ThedefaultvaluefortheDefaultQueryOnLoadpropertyisTrue.ThePurposeattributeisinthedataretrievalserviceconnectionbindingdetailcontainedinthe<DataSource>elementintheXMLSpreadsheetfile(Binding/DataSource/ConnectionInfo@Purpose).TheLoadModeattributeisinthe<Binding>element.TheXMLfragmentwherethesedetailsappearintheXMLSpreadsheetfilelookssomethinglikefollowing:

<x2:Bindingx2:ID="Cust_bind_id"x2:LoadMode="Normal"x2:Async="False"><x2:MapID>Cust_MapId</x2:MapID><udc:DataSourceMajorVersion="1"MinorVersion="0"><udc:TypeType="XMLFile"MajorVersion="1"MinorVersion="0"/><udc:Name>sample_name</udc:Name><udc:ConnectionInfoPurpose="Query">

DefaultRecordsetProperty

ReturnsthedefaultADORecordsetobjectforthespecifiedcontrol.Read-only.

expression.DefaultRecordset

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RemarksYoushouldnotusethispropertywithsectionsthatareboundtorecordsets;instead,usetheDataPageobject'sRecordsetproperty.

DefaultSortProperty

Returnsorsetsthefield(orfields)onwhichthespecifiedbandinglevelissorted.Thefieldmustbepartofthebandinglevel.Ifyouusethispropertytospecifymultiplefields,usecommastoseparatethefields.Read/writeString.

expression.DefaultSort

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

DefaultValueProperty

Returnsorsetsthevaluethatisplacedinthespecifiedcontrolwhenevertheusercreatesanewrecord.Appliestoanyboundcontrol,anycontrolwithaValueproperty,oranycontrolthatmeetsbothofthesecriteria.Read/writeStringfortheElementExtensionobject;read/writeVariantforthePivotFieldobject.

expression.DefaultValue

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

DesignModeProperty

Trueifthespreadsheetcontroliscurrentlyindesignmode.Read-onlyBoolean.

expression.DesignMode

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ShowAll

DetailAutoFitProperty

DetailAutoFitpropertyasitappliestothePivotFieldobject.

DetailAutoFitpropertyasitappliestothePivotViewobject.

DetailBackColorProperty

Returnsorsetsthebackcolorforthespecifiedfieldwhenthefieldisdisplayedinadetailgrid.Thedefaultbackcoloriswhite.Read/writeVariant.

expression.DetailBackColor

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

DetailCellsProperty

ReturnsaPivotDetailCellobjectbasedonarowandcolumnindex.UsethispropertytoaccessthepropertiesofindividualcellsinthedetailareaofaPivotTablelist.

expression.Cell(Row,Column)

expressionAnexpressionthatreturnsaPivotCellobject.

RowRequiredLong.Specifiestherowthatcontainsthespecifiedcell.

ColumnRequiredLong.Specifiesthecolumnthatcontainsthespecifiedcell.

DetailColumnCountProperty

ReturnsaLongvaluethatrepresentsthenumberofcolumnsofdetailcellsinthespecifiedcell.Read-only.

expression.DetailColumnCount

expressionRequired.AnexpressionthatreturnsaPivotCellobject.

RemarksUsingthispropertywhenthePivotTablelistisconnectedtoanOLAPdatasourcewillresultinarun-timeerror.

DetailFontProperty

ReturnsaPivotFontobjectthatrepresentsthefontusedwhenthespecifiedfieldisdisplayedinthedetailgrid.Read-only.

expression.DetailFont

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

DetailForeColorProperty

Returnsorsetstheforegroundcolorforthespecifiedfieldwhenthefieldisdisplayedinadetailgrid.Read/writeVariant.

expression.DetailForeColor

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

ExampleThisexampleaddsinsertsfieldsintoPivotTable1,addatotal,andthenformatsthefieldinthedetailareaofthePivotTablelist.

SubLayout_PivotTable1()DimvwViewDimptConstantsDimtotOrderCountSetptConstants=PivotTable1.ConstantsSetvwView=PivotTable1.ActiveView'AddtheShipCountryfieldtotherowaxis.vwView.RowAxis.InsertFieldSetvwView.FieldSets("ShipCountry")'AddtheOrderIdfieldtothedataaxis.vwView.DataAxis.InsertFieldSetvwView.FieldSets("OrderID")'AddtheShipViafieldtothefilteraxis.vwView.FilterAxis.InsertFieldSetvwView.FieldSets("ShipVia")'Createatotalnamed"OrderCount"thatcountstheOrderIDfield.SettotOrderCount=vwView.AddTotal("OrderCount",vwView.FieldSets("OrderId").Fields("OrderId"),_ptConstants.plFunctionCount)'AddtheOrderCounttotaltothedataaxis.vwView.DataAxis.InsertTotaltotOrderCount'SetthehorizontalalignmentoftheOrderIDfield.vwView.FieldSets("OrderId").Fields("OrderId").DetailHAlignment=plHAlignCenter

'SettheforegroundcoloroftheOrderIdfield.vwView.FieldSets("OrderId").Fields("OrderId").DetailForeColor=RGB(100,100,200)EndSub

ShowAll

DetailHAlignmentProperty

Returnsorsetsthewayfieldvaluesarehorizontallyalignedwhenthespecifiedfieldisdisplayedinadetailgrid.Bydefault,valuesareleft-aligned.Read/writePivotHAlignmentEnum.

expression.DetailHAlignment

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ExampleThisexampleaddsinsertsfieldsintoPivotTable1,addatotal,andthenformatsthefieldinthedetailareaofthePivotTablelist.

SubLayout_PivotTable1()DimvwViewDimptConstantsDimtotOrderCountSetptConstants=PivotTable1.ConstantsSetvwView=PivotTable1.ActiveView'AddtheShipCountryfieldtotherowaxis.vwView.RowAxis.InsertFieldSetvwView.FieldSets("ShipCountry")'AddtheOrderIdfieldtothedataaxis.vwView.DataAxis.InsertFieldSetvwView.FieldSets("OrderID")'AddtheShipViafieldtothefilteraxis.vwView.FilterAxis.InsertFieldSetvwView.FieldSets("ShipVia")'Createatotalnamed"OrderCount"thatcounts'theOrderIDfield.SettotOrderCount=vwView.AddTotal("OrderCount",vwView.FieldSets("OrderId").Fields("OrderId"),_ptConstants.plFunctionCount)'AddtheOrderCounttotaltothedataaxis.vwView.DataAxis.InsertTotaltotOrderCount

'SetthehorizontalalignmentoftheOrderIDfield.vwView.FieldSets("OrderId").Fields("OrderId").DetailHAlignment'SettheforegroundcoloroftheOrderIdfield.vwView.FieldSets("OrderId").Fields("OrderId").DetailForeColor=RGB(100,100,200)EndSub

DetailLeftProperty

ReturnsorsetsaLongthatrepresentstheleftmostvisiblecolumninthedetailgrid.Read/write.

expression.DetailLeft(Column)

expressionAnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ColumnRequiredPivotMemberobject.Specifiestheleftmostvisiblecolumninthedetailgrid.

DetailLeftOffsetProperty

ReturnsorsetsaLongvaluethatrepresentsthenumberofpixelsthatthedatainthedetailareaisoffsettotheleft.Usethispropertytomovethedatainthedetailareatotheleft.Read/write.

expression.DetailLeftOffset

expressionRequired.AnexpressionthatreturnsaPivotColumnMemberobject.

RemarksSettingthispropertytoanegativevaluewillresultinarun-timeerror.

ExampleThisexamplemovesthedatainthedetailareaofPivotTable110pixelstotheleft.

PivotTable1.ActiveData.ColumnAxis.ColumnMember.DetailLeftOffset

DetailMaxHeightProperty

Returnsorsetsthemaximumheight(inpixels)thatthedetailgridcanattainwhenthevalueoftheDetailAutoFitpropertyisTrue.Ascrollbarisdisplayediftheheightofthedetailgridwouldexceedthemaximumheight.Thedefaultvalueis250pixels.ThispropertyisignoredifthevalueoftheDetailAutoFitpropertyisFalse.Read/writeLong.

expression.DetailMaxHeight

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

DetailMaxWidthProperty

Returnsorsetsthemaximumwidth(inpixels)thatthedetailgridcanattainwhenthevalueoftheDetailAutoFitpropertyisTrue.Ascrollbarisdisplayedifthewidthofthedetailgridwouldexceedthemaximumwidth.Thedefaultvalueis1024pixels.ThispropertyisignoredifthevalueoftheDetailAutoFitpropertyisFalse.Read/writeLong.

expression.DetailMaxWidth

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

DetailRangeProperty

ReturnsaPivotDetailRangeobjectforthespecifiedarea.

expression.DetailRange(TopLeft,BottomRight)

expressionAnexpressionthatreturnsaPivotCellobject.

TopLeftRequiredPivotDetailCellobject.Specifiestheupper-leftcellinthedetailrange.

BottomRightRequiredPivotDetailCellobject.Specifiesthelower-rightcellinthedetailrange.

DetailRowCountProperty

ReturnsaLongvaluethatrepresentsthenumberofrowsinthedetailareathatcontainsthespecifiedcell.Read-only.

expression.DetailRowCount

expressionRequired.AnexpressionthatreturnsaPivotCellobject.

RemarksUsingthispropertywhenthePivotTablelistisconnectedtoanOLAPdatasourcewillresultinarun-timeerror.

DetailRowHeightProperty

Returnsorsetstherowheightforthedetailgrid(inpixels).Thedefaultvalueis10pixels.Read/writeLong.

expression.DetailRowHeight

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

DetailsExpandedProperty

ReturnswhetherornotthedetailshavebeenexpandedinthedetailareaofthePivotTablelist.Read-onlyBoolean.

expression.DetailsExpanded

expressionRequired.AnexpressionthatreturnsaPivotColumnMemberobject.

RemarksUsingthispropertywhenthePivotTablelistisconnectedtoanOLAPdatasourcewillresultinarun-timeerror.

DetailSortOrderProperty

Returnsorsetsthesortorderforfieldsonthesummaryaxis.Read/writeVariant.

expression.DetailSortOrder

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksFieldsaresortedinarrayorder.IfafieldincludedinthesortorderarrayhasitsSortDirectionpropertysettoplSortDirectionDefault,thefieldisignored.

DetailTopProperty

Returnsorsetstheindexoftheuppermostvisiblerowinthedetailgrid.Read/writeLong.

expression.DetailTop

expressionRequired.AnexpressionthatreturnsaPivotCellobject.

DetailTopOffsetProperty

ReturnsorsetsaLongvaluethatrepresentsthenumberofpixelsthatthespecifiedcellinthedetailareaisoffsettothetop.Usethispropertytomoveacellinthedetailareaupward.Read/write.

expression.DetailTopOffset

expressionRequired.AnexpressionthatreturnsaPivotCellobject.

RemarksSettingthispropertytoanegativevaluewillresultinarun-timeerror.

ExampleThisexamplemovesscrollsthecurrentlyselectedcellinthedetailareaofPivotTable1upby15pixels

PivotTable1.ActiveData.CurrentCell.DetailTopOffset=15

DetailWidthProperty

Returnsorsetsthewidthofthespecifiedfield(inpixels)whenitisdisplayedinthedetailgrid.Read/writeLong.

expression.DetailWidth

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ShowAll

DirectionProperty

DirectionpropertyasitappliestotheChErrorBarsobject.

DirectionpropertyasitappliestotheSchemaParameterobject.

ExampleAsitappliestotheChErrorBarsobject.

DirectionalLightInclinationProperty

ReturnsorsetsaDoublespecifyingtherotationofthedirectionallightsourcealongthex-zplaneofthespecifiedchart.Validsettingsrangefrom-90to90.Settingthispropertyto-90placesthelightsourcedirectlybelowthechart.Settingthispropertyto90placesthelightsourcedirectlyabovethechart.Read/write.

expression.DirectionalLightInclination

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DBarchartandsetsthelightingoptionsforthechart.

SubFormat3DLightSources()

Dimcht3DBar

'SetavariabletothefirstchartinChartspace1.Setcht3DBar=ChartSpace1.Charts(0)

'Changethecharttoa3-DBarchart.cht3DBar.Type=chChartTypeBar3D

'Settheintensityoftheambientlight.cht3DBar.AmbientLightIntensity=0.7

'Settheinclinationofthedirectionallightsource.cht3DBar.DirectionalLightInclination=35

'Settheintensityofthedirectionallightsource.cht3DBar.DirectionalLightIntensity=0.8

'Settherotationofthedirectionallightsource.cht3DBar.DirectionalLightRotation=120

EndSub

DirectionalLightIntensityProperty

ReturnsorsetsaDoublespecifyingtheintensityofthedirectionallightsourceforathree-dimensionalchart.Validsettingsrangefrom0to1.Read/write.

expression.DirectionalLightIntensity

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DBarchartandsetsthelightingoptionsforthechart.

SubFormat_3D_LightSources()

Dimcht3DBar

'SetavariabletothefirstchartinChartspace1.Setcht3DBar=ChartSpace1.Charts(0)

'Changethecharttoa3DBarchart.cht3DBar.Type=chChartTypeBar3D

'Settheintensityoftheambientlight.cht3DBar.AmbientLightIntensity=0.7

'Settheinclinationofthedirectionallightsource.cht3DBar.DirectionalLightInclination=35

'Settheintensityofthedirectionallightsource.cht3DBar.DirectionalLightIntensity=0.8

'Settherotationofthedirectionallightsource.cht3DBar.DirectionalLightRotation=120EndSub

DirectionalLightRotationProperty

ReturnsorsetsaDoublespecifyingtherotationofthedirectionallightsourceforathree-dimensionalchart.Validsettingsarebetween0and360.Read/write.

expression.DirectionalLightRotation

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksThedirectionallightsourcerotatesaroundthey-axisofthechart.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DBarchartandsetsthelightingoptionsforthechart.

SubFormat3DLightSources()

Dimcht3DBar

'SetavariabletothefirstchartinChartspace1.Setcht3DBar=ChartSpace1.Charts(0)

'Changethecharttoa3DBarchart.cht3DBar.Type=chChartTypeBar3D

'Settheintensityoftheambientlight.cht3DBar.AmbientLightIntensity=0.7

'Settheinclinationofthedirectionallightsource.cht3DBar.DirectionalLightInclination=35

'Settheintensityofthedirectionallightsource.cht3DBar.DirectionalLightIntensity=0.8

'Settherotationofthedirectionallightsource.cht3DBar.DirectionalLightRotation=120

EndSub

DirtyProperty

Trueifchangeshavebeenmadetothespreadsheetsincethelasttimeitwassaved.Read/writeBoolean.

expression.Dirty

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexampleexportsthespreadsheettoafileifchangeshavebeenmadetoitsincethelasttimeitwassaved.

IfSpreadsheet1.DirtyThenSpreadsheet1.Export"sstest.xls",Spreadsheet1.Constants.ssExportActionNoneEndIf

ShowAll

DisplayAlertProperty

ReturnsorsetsaDscDisplayAlertconstantthatindicateswhetherornotanalertwillbedisplayedwhentheBeforeDeleteandBeforeOverwriteeventsarecalled.Read/write.

expression.DisplayAlert

expressionRequired.AnexpressionthatreturnsaDSCEventInfoobject.

ExampleThefollowingexampleusestheDisplayAlertpropertyintheBeforeOverwriteeventtopreventtheuserfrombeingpromptedtooverwriteanexistingfilewhentheExportXMLmethodiscalled.

SubMSODSC_BeforeOverwrite(DSCEventInfo)

DimdscConstantsSetdscConstants=MSODSC.Constants

'Don'talerttheuserwhenoverwritinganexistingfile.DSCEventInfo.DisplayAlert=dscConstants.dscDataAlertContinue

EndSub

DisplayAlertsProperty

Trueifcertainalertsandmessagesaretobedisplayedwhilecodeisrunning.ThedefaultvalueisTrue.SetthispropertytoFalseifyoudon'twanttobedisturbedbypromptsandalertmessages;anytimeamessagerequiresaresponse,thedefaultresponseischosen.

IfyousetthispropertytoFalse,itisnotautomaticallysetbacktoTrue,andmustbesettoTrueformessagesandalertstoappear.Read/writeBoolean.

expression.DisplayAlerts

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

DisplayCalculatedMembersProperty

ReturnsorsetsaBooleanthatdetermineswhethercalculatedmembersaredisplayed.SetthispropertytoFalsetohidecalculatedmembers.ThedefaultvalueisTrue.Read/write.

expression.DisplayCalculatedMembers

expressionRequired.AnexpressionthatreturnsaPivotViewobject

DisplayColumnHeadingsProperty

Returnsorsetswhethercolumnheadingsaredisplayedinthespecifiedwindow.SetthispropertytoFalsetohidethecolumnsheadings.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayColumnHeadings

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplehidestherowandcolumnheadingsintheactivewindowofSpreadsheet1.

SubHideHeadings()Spreadsheet1.ActiveWindow.DisplayColumnHeadings=FalseSpreadsheet1.ActiveWindow.DisplayRowHeadings=FalseEndSub

DisplayCustomHeadingsProperty

Determineswhethercustomrowandcolumnheadings,iftheyexist,aretobedisplayedinthespecifiedwindow.ThedefaultvalueitTrue.Read/writeBoolean.

expression.DisplayCustomHeadings

expressionRequired.AnexpressionthatreturnsaWindowobject.

RemarksAlthoughsettingthispropertytoFalsehidescustomrowandcolumnheadings,theyarenotresetthemtotheirdefaultvalues.UsethispropertyinsteadofusingtheResetHeadingsmethodtotemporarilyhidethecustomrowandcolumnheadings.

ExampleThisexamplepreventsthedisplayofthecustomrowandcolumnheadingsintheactivewindowofSpreadsheet1.

Spreadsheet1.ActiveWindow.DisplayCustomHeadings=False

DisplayDesignTimeUIProperty

Truetodisplaythedesign-timeversionoftheCommandsandOptionswindowisdisplayedatruntime.ThedefaultvalueisFalse.Read/writeBoolean.

expression.DisplayDesignTimeUI

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsSpreadsheet1sothatthedesign-timeCommandsandOptionswindowwillbedisplayedatruntime.

Spreadsheet1.DisplayDesignTimeUI=True

DisplayEmptyMembersProperty

Trueifemptymembersaredisplayed,eveniftheydonothaveaggregates.ThedefaultvalueisFalse.Read/writeBoolean.

expression.DisplayEmptyMembers

expressionRequired.AnexpressionthatreturnsaPivotGroupAxisobject.

DisplayExpandIndicatorProperty

Trueifexpansionindicatorsaredisplayedformemberswithavailablechildmembersordetailrecords.Whentheexpansionindicatorishidden,thememberdisplaynameappearsinthisspace.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayExpandIndicator

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

DisplayFieldButtonsProperty

Returnsorsetswhetherfieldbuttonsanddropzonesaredisplayedonthechart.SetthispropertytoFalsetohidethefieldbuttonsanddropzones.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayFieldButtons

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksThispropertyhasnoeffectifthechartcontrolisboundtoaliteraldatasource.

ExampleThisexamplehidesthedropzonesandfieldbuttonsonChartspace1.

Chartspace1.DisplayFieldButtons=False

DisplayFieldListProperty

SetthispropertytoTruetodisplaytheFieldList.ThedefaultvalueisFalse.Read/writeBoolean.

expression.DisplayFieldList

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

DisplayGridlinesProperty

Trueifgridlinesaredisplayedonthespecifiedspreadsheet.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayGridlines

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplehidesgridlinesonthespreadsheet.

Spreadsheet1.ActiveWindow.DisplayGridlines=False

DisplayHeadingsProperty

Trueifbothrowandcolumnheadingsaredisplayed;Falseiftherearenoheadingsdisplayed,orifeitherthecolumnorrowheadingsarenotdisplayed.Read/writeBoolean.

expression.DisplayHeadings

expressionRequired.AnexpressionthatreturnsaWindowobject.

RemarksYoucanusetheDisplayColumnHeadingsandDisplayRowHeadingspropertiestoindependentlycontrolthedisplayofcolumnandrowheadings.

ExampleThisexamplehidestherowandcolumnheadingsintheactivewindowofSpreadsheet1.

Spreadsheet1.ActiveWindow.DisplayHeadings=False

DisplayHorizontalScrollBarProperty

Trueifthehorizontalscrollbarisdisplayedonthespecifiedspreadsheet.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayHorizontalScrollBar

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplehidesthehorizontalscrollbaronthespreadsheet.

Spreadsheet1.ActiveWindow.DisplayHorizontalScrollBar=False

ShowAll

DisplayInProperty

ReturnsorsetsaPivotMemberPropertyDisplayEnumconstantthatdetermineswhetherthespecifiedmemberpropertyisdisplayedinthePivotTablelist,ScreenTip,boththePivotTablelistandScreenTip,ornotatall.Read/write.

expression.DisplayIn

expressionRequired.AnexpressionthatreturnsaPivotMemberPropertyobject.

ExampleThisexamplesetsthecaptionsof,andthendisplaysthemembercaptionsoftheStoreNamefield.

SubDisplay_MemberProperties()DimptViewDimptConstantsDimfldStoreName

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetptView=PivotTable1.ActiveView

'SetavariabletotheStoreNamefield.SetfldStoreName=ptView.FieldSets("Store").Fields("StoreName")

'Thefollowingthreelinesofcodespecifythatthememberpropertiesare'displayedinthePivotTablelist.fldStoreName.MemberProperties("StoreManager").DisplayIn=ptConstants.plDisplayPropertyInReportfldStoreName.MemberProperties("StoreType").DisplayIn=ptConstants.plDisplayPropertyInReportfldStoreName.MemberProperties("StoreSqft").DisplayIn=ptConstants.plDisplayPropertyInReport

'Thefollowingthreelinesofcodesetthecaptionforthememberproperties.fldStoreName.MemberProperties("StoreManager").Caption="ManagerName"fldStoreName.MemberProperties("StoreType").Caption="StoreType"fldStoreName.MemberProperties("StoreSqft").Caption="SizeinSQFT"EndSub

DisplayInFieldListProperty

ReturnsorsetswhetherthespecifiedfieldsetortotalappearsinthePivotTableFieldListdialogbox.SetthispropertytoFalsetopreventthespecifiedfieldsetortotalfromappearinginthePivotTableFieldListdialogbox.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayInFieldList

expressionRequired.AnexpressionthatreturnsaPivotFieldSetorPivotTotalobject.

ExampleThisexampleaddsanewtotaltoPivotTable1.Thenewtotalisformattedtodisplayasapercentageoftheparentrowfield,andwillnotappearinthePivotTableFieldListdialogbox.

SubAdd_Total()

DimvwViewDimptConstantsDimtotNewTotal

SetvwView=PivotTable1.ActiveViewSetptConstants=PivotTable1.Constants

'Addanewtotalnamed"TotalBudget"tothecurrentview.SettotNewTotal=vwView.AddTotal("TotalBudget",vwView.FieldSets("Budget").Fields(0),_ptConstants.plFunctionSum)

'InsertthenewlycreatedtotalintothedetailareaofthePivotTable.vwView.DataAxis.InsertTotaltotNewTotal

'Showthetotalsasapercentageoftheparentrowfield.totNewTotal.ShowAs=ptConstants.plShowAsPercentOfRowParent

'DonotdisplaythenewtotalinthePivotTableFieldListdialogbox.totNewTotal.DisplayInFieldList=False

EndSub

DisplayOfficeLogoProperty

TruetodisplaytheMicrosoftOfficelogoonthetoolbar.Read/writeBoolean.

expression.DisplayOfficeLogo

expressionRequired.AnexpressionthatreturnsaChartSpace,PivotTable,orSpreadsheetobject.

ExampleThisexamplehidestheMicrosoftOfficelogoonPivotTable1'stoolbar.

PivotTable1.DisplayOfficeLogo=False

DisplayPropertyToolboxProperty

SetthispropertytoTruetodisplaytheCommandandOptionswindow.Read/writeBoolean.

expression.DisplayPropertyToolbox

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

DisplayRowHeadingsProperty

Determineswhetherrowheadingsaredisplayedinthespecifiedwindow.SetthispropertytoFalsetohidetherowheaders.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayRowHeadings

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplehidestherowandcolumnheadingsintheactivewindowofSpreadsheet1.

SubHideHeadings()Spreadsheet1.ActiveWindow.DisplayColumnHeadings=FalseSpreadsheet1.ActiveWindow.DisplayRowHeadings=FalseEndSub

DisplayScreenTipsProperty

ReturnsorsetswhetherScreenTipsaredisplayed.SetthispropertytoFalsetopreventthedisplayofScreenTips.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayScreenTips

expressionRequired.AnexpressionthatreturnsaPivotTableorChartSpaceobject.

ExampleThisexampledisablesScreenTipsforPivotTable1.

PivotTable1.DisplayScreenTips=False

DisplayTitleBarProperty

Trueifthetitlebaronthespecifiedspreadsheetisdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayTitleBar

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexamplehidesthespreadsheet’stitlebar.

Spreadsheet1.DisplayTitleBar=False

DisplayToolbarProperty

Trueifthetoolbaronthespecifiedspreadsheet,chartspace,orPivotTablelistisdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayToolbar

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksHidingthetoolbardoesnotchangetheheightofthePivotTablelist,butitdoescausealayoutchange.ThewidthisunchangedunlesstheAutoFitpropertyisTrueandthePivotTablelistwassizedwiderthanthenecessarytoaccommodatethetoolbar.

ExampleThisexamplehidesthespreadsheet’stoolbar.

Spreadsheet1.DisplayToolbar=False

DisplayTotalProperty

ReturnswhetherornottotalsaredisplayedforthespecifiedPivotResultGroupFieldobject.Read-onlyBoolean.

expression.DisplayTotal

expressionRequired.AnexpressionthatreturnsaPivotResultGroupFieldobject.

DisplayVerticalScrollBarProperty

Trueiftheverticalscrollbaronthespecifiedspreadsheetisdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayVerticalScrollBar

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplehidesthespreadsheet’sverticalscrollbar.

Spreadsheet1.ActiveWindow.DisplayVerticalScrollBar=False

DisplayWorkbookTabsProperty

Trueiftheworkbooktabsaredisplayed.SettingthispropertytoFalseforasingleWindowobjectsetsthispropertytoFalseforallwindowsintheworkbook.ThedefaultvalueisTrue.Read/writeBoolean.

expression.DisplayWorkbookTabs

expressionRequired.AnexpressionthatreturnsaWindowobject.

DisplayZerosProperty

Trueifzerovaluesaredisplayed.SetthispropertytoFalseifyouwanttohideallzerovaluesinthespecifiedwindow.Read/writeBoolean.

expression.DisplayZeros

expressionRequired.AnexpressionthatreturnsaWindowobject.

DivisionsProperty

ReturnsorsetsaLongvaluethatrepresentsthenumberofdivisionsthatappearinthelegendforthespecifiedsegment.Read/write.

expression.Divisions

expressionRequired.AnexpressionthatreturnsaChSegmentobject.

ExampleThisexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreatedthatdisplaysthelargervaluesinthechartwithadarkershadeofblue.

SubWindow_Onload()

DimserSeries1DimsegSegment1DimchConstants

SetchConstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;PersistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=ServerName;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderdetailstable.ChartSpace1.SetDatachConstants.chDimCategories,chConstants.chDataBound,"ProductID"ChartSpace1.SetDatachConstants.chDimValues,chConstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachConstants.chDimFormatValues,chConstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.SetsegSegment1=serSeries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segSegment1.Begin.ValueType=chConstants.chBoundaryValuePercentsegSegment1.End.ValueType=chConstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto100%.segSegment1.Begin.Value=0segSegment1.End.Value=1

'Formattheinteriorofthematchingvalues.segSegment1.Begin.Interior.Color="White"segSegment1.End.Interior.Color="Blue"

segSegment1.HasDiscreteDivisions=True

segSegment1.Divisions=3

EndSub

ShowAll

DrawTypeProperty

ReturnsaChartDrawModesEnumconstantindicatingwhichdrawingpassisbeingperformed.Read-only.

expression.DrawType

expressionRequired.AnexpressionthatreturnsaChChartDrawobject.

ShowAll

EditModeProperty

ReturnsaPivotEditModeEnumconstantthatindicateswhetherthePivotTablelistiscurrentlyineditmode.Read-only.

expression.EditMode

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

ElementExtensionsProperty

ReturnstheElementExtensionsobjectforthedatasourcecontrol.

expression.ElementExtensions

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ElementIDProperty

SpecifiestheIDtagfortheHTMLelementusedwiththespecifiedextension.Read-onlyString.

expression.ElementID

expressionRequired.AnexpressionthatreturnsaElementExtensionobject.

EnableAutoFilterProperty

Trueifthespecifiedworksheetcanbefiltered.ThispropertyhasnoeffectiftheProtectionEnabledpropertyissettoFalse.Read/writeBoolean.

expression.EnableAutoFilter

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

ExampleThisexampleenablesAutoFilterfortheactiveworksheet,andthenprotectstheworksheetinSpreadsheet1.

SubProtectWorksheet_EnableAutoFilterSpreadsheet1.ActiveSheet.EnableAutoFilter=TrueSpreadsheet1.ActiveSheet.Protection.Enabled=TrueEndSub

EnabledProperty

OCCommandobject:ReturnsaBooleanthatrepresentswhetherornotthespecifiedcommandisenabled.Readonly.

Protectionobject:ReturnsorsetsaBooleanthatdetermineswhetherornotprotectionisenabledforthespecifiedworksheet.SetthispropertytoTruetoprotecttheworksheet.IfthispropertyissettoFalse,theotherProtectionobjectpropertysettingsareignored.Read/write.

expression.Enabled

expressionRequired.AnexpressionthatreturnsanOCCommandorProtectionobject.

ExampleThisexamplepreventsauserfrominsertingrowsontheactiveworksheet.

SubPreventInsertingRows()

Dimpt

Setpt=Spreadsheet1.ActiveSheet.Protection

pt.AllowInsertingRows=False

pt.Enabled=True

EndSub

EnableEventsProperty

Trueifeventsareenabledforthespreadsheetorthechartworkspace.Read/writeBoolean.

expression.EnableEvents

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplepreventsspreadsheeteventproceduresfromrunning.

Spreadsheet1.EnableEvents=False

EnableResizeProperty

Trueifthespreadsheetcontrolcanberesizedbytheuser.SetthispropertytoFalsetopreventtheuserfromresizingthespreadsheetcontrol.ThedefaultvalueisTrue.Read/writeBoolean.

expression.EnableResize

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplesetstheheightandwidthofthespreadsheetcontrolandthenpreventstheuserfromresizingthecontrol.

SubSize_Spreadsheet()'Settheheightofthespreadsheetcontrol.Spreadsheet1.Height=4000

'Setthewidthofthespreadsheetcontrol.Spreadsheet1.Width=6000

'Preventtheuserfromresizingthespreadsheetcontrol.Spreadsheet1.ActiveWindow.EnableResize=FalseEndSub

EnableUndoProperty

Trueiftheundofunctionalityisenabledforthespecifiedspreadsheet.SettingtheEnableUndopropertytoFalsedisablestheundofunctionalityofthespreadsheetcomponent.Read/writeBoolean.

expression.EnableUndo

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexamplecreatesanundoblockcontainingcodethatsetsthenumberformatandfontforthecellD10.

SubUndo_Block()DimrngCurrent'Enableundo.Spreadsheet1.EnableUndo=True'Startanundoblock.Spreadsheet1.BeginUndoSetrngCurrent=Spreadsheet1.Worksheets("sheet1").Range("D10")'Thefollowingthreelinesofcodeapply'variousformattingtocellD10.rngCurrent.NumberFormat="0.###"rngCurrent.Font.Color="Blue"rngCurrent.Font.Name="TimesNewRoman"'Endtheundoblock.Spreadsheet1.EndUndoEndSub

ShowAll

EndProperty

EndpropertyasitappliestotheRangeobject.

EndpropertyasitappliestotheChSegmentobject.

ExampleAsitappliestotheRangeobject.

AsitappliestotheChSegmentobject.

ShowAll

EndStyleProperty

Returnsorsetstheendstyleforerrorbars.Read/writeChartEndStyleEnum.

expression.EndStyle

expressionRequired.AnexpressionthatreturnsaChErrorBarsobject

ExampleThisexampleaddserrorbarstoalloftheseriesinthefirstchartinChartSpace1andthensetstheerroramountandendstyle.

SubAdd_Error_Bars()DimebErrorBarsDimserChartSeriesDimchConstants

SetchConstants=ChartSpace1.Constants

'Loopthroughalloftheseriesinthefirstchart'inChartSpace1.ForEachserChartSeriesinChartSpace1.Charts(0).SeriesCollection

'Adderrorbarstothecurrentseries.SetebErrorBars=serChartSeries.ErrorBarsCollection.Add

'Settheerrorbarstobeapercentageofthevalue.eberrorBars.Type=chConstants.chErrorBarTypePercent'Setthepercentageamount.ebErrorBars.Amount=0.05'Settheendstyleoftheerrorbars.ebErrorBars.EndStyle=chConstants.chEndStyleNoneNextEndSub

EntireColumnProperty

ReturnsaRangeobjectthatrepresentstheentirecolumn(orcolumns)containingthespecifiedrange.Read-only.

expression.EntireColumn

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplesetsthefontcolorfortheentirecolumncontainingtheactivecell.

Spreadsheet1.ActiveCell.EntireColumn.Font.Color="green"

EntireRowProperty

ReturnsaRangeobjectthatrepresentstheentirerow(orrows)containingthespecifiedrange.Read-only.

expression.EntireRow

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplesetsthefontcolorfortheentirerowcontainingtheactivecell.

Spreadsheet1.ActiveCell.EntireRow.Font.Color="red"

ErrorProperty

ReturnsanADOErrorobjectthatcontainserrorinformationaboutthespecifiedevent.Read-only.

expression.Error

expressionRequired.AnexpressionthatreturnsaDSCEventInfoobject.

ErrorBarsCollectionProperty

ReturnsaChErrorBarsCollectioncollectionthatcontainsaChErrorBarsobjectforeachsetoferrorbarsinthespecifiedseries.Aseriescanhaveonlyonesetoferrorbars,sotheChErrorBarsCollectioncollectionnevercontainsmorethanoneobject.Read-only.

expression.ErrorBarsCollection

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

ExampleThisexampleaddserrorbarstoalloftheseriesinthefirstchartinChartSpace1andthensetstheerroramountandendstyle.

SubAdd_Error_Bars()DimebErrorBarsDimserChartSeriesDimchConstants

SetchConstants=ChartSpace1.Constants

'Loopthroughalloftheseriesinthefirstchart'inChartSpace1.ForEachserChartSeriesinChartSpace1.Charts(0).SeriesCollection

'Adderrorbarstothecurrentseries.SetebErrorBars=serChartSeries.ErrorBarsCollection.Add

'Settheerrorbarstobeapercentageofthevalue.eberrorBars.Type=chConstants.chErrorBarTypePercent'Setthepercentageamount.ebErrorBars.Amount=0.05'Settheendstyleoftheerrorbars.ebErrorBars.EndStyle=chConstants.chEndStyleNoneNextEndSub

ExcludedMembersProperty

Returnsorsetsthemembersthatyoudonotwanttobedisplayedinthespecifiedfield.ThispropertycanbesettoasinglememberoraVariantarrayofmembers.ThememberscanbepassedasoneormorePivotMemberobjects,membernames,oruniquemembernames.

expression.ExcludedMembers

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksMembersthatareexplicitlyexcludedstillappearinthePivotTablelistifoneormoreoftheirchildrenareincluded.Settingthispropertyclearsallprevioussettingsofthispropertyforthespecifiedfield.YoucansettheExcludedMemberspropertytoEmpty(ExcludedMembers=Empty)ortoazero-lengthVariantarray(ExcludedMembers=Array())tocleartheincludedmemberslistforthespecifiedfield.

ExampleThisexamplesetstheincludedandexcludedmembersoftheStoreStateandStoreCityfieldsinPivotTable1.

SubMember_Filtering()

DimfldStoreCityDimfldStoreStateDimptView

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'SetavariabletotheStoreStatefield.SetfldStoreState=ptView.FieldSets("Store").Fields("StoreState")

'SetavariabletotheStoreCityfield.SetfldStoreCity=ptView.FieldSets("Store").Fields("StoreCity")

'ExcludeCaliforniaandWashingtonfromtheStoreStatefield.fldStoreState.ExcludedMembers=Array("CA","WA")

'IncludemembersoftheStoreCityfield.Notethatthecitiesare'instatesthathavebeenexcludedbythepreviousline.Since'StoreStateisaparenttoStoreCity,thentheexcludedstates'aredisplayedinthePivotTable.fldStoreCity.IncludedMembers=Array("LosAngeles","SanDiego",_"Seattle","Spokane")

EndSub

ShowAll

ExpandDetailsProperty

ReturnsorsetsaPivotTableExpandEnumconstantthatrepresentswhetherornotfieldsareexpandedwhenaddedtothedetailareaofaPivotTablelist.Read/write.

expression.ExpandDetails

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

ExampleThisexamplesetsPivotTable1sothatfieldsareneverexpandedwhentheyareaddedtothePivotTablelist.

SubNeverExpand()DimpvtViewDimptConstants

SetptConstants=PivotTable1.Constants

'Setavariabletotheactiveview.SetpvtView=PivotTable1.ActiveView

'Alwaysexpandfieldswhentheyareadded'toaPivotTablelist.pvtView.ExpandMembers=ptConstants.plExpandNever

'Alwaysexpandfieldswhentheyareadded'tothedetailareaPivotTablelist.pvtView.ExpandDetails=ptConstants.plExpandNeverEndSub

ExpandedProperty

PivotCellobject:Trueifthedetailgridisbeingdisplayedforthespecifiedcell.IfthispropertyissettoFalse,thedetailgridisnotdisplayedbutaggregatesaredisplayediftheyareavailable.Read/writeBoolean.

PivotAxisMemberobject:Trueifchildmembersarebeingdisplayedforthespecifiedmember;Falseifchildmembersarecollapsed.Read/writeBoolean.

PivotFieldobject:Returnsorsetstheexpandedstateofallthemembersofthespecifiedfieldatthesametime.SettingtheExpandedpropertyforthefieldimmediatelysetstheExpandedpropertyforallthemembersassociatedwiththefield.SettingtheExpandedpropertyforasinglememberofthefielddoesnotaffecttheExpandedpropertyforthefielditself.Read/writeBoolean.

expression.Expanded

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExpandedByDefaultProperty

Trueifthespecifiedgrouplevelisexpandedbydefault.ThedefaultvalueisFalse.Read/writeBoolean.

expression.ExpandedByDefault

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

ShowAll

ExpandMembersProperty

ReturnsorsetsaPivotTableExpandEnumconstantthatrepresentswhetherornotfieldsandtheirmembersareexpandedwhenafieldisaddedtoaPivotTablelist.Read/write.

expression.ExpandMembers

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

ExampleThisexamplesetsPivotTable1sothatfieldsareneverexpandedwhentheyareaddedtothePivotTablelist.

SubNeverExpand()DimpvtViewDimptConstants

SetptConstants=PivotTable1.Constants

'Setavariabletotheactiveview.SetpvtView=PivotTable1.ActiveView

'Alwaysexpandfieldswhentheyareadded'toaPivotTablelist.pvtView.ExpandMembers=ptConstants.plExpandNever

'Alwaysexpandfieldswhentheyareadded'tothedetailareaPivotTablelist.pvtView.ExpandDetails=ptConstants.plExpandNeverEndSub

ShowAll

ExplosionProperty

ExplosionpropertyasitappliestotheChPointobject.

ExplosionpropertyasitappliestotheChSeriesobject.

ExampleAsitappliestotheChPointobject.

AsitappliestotheChSeriesobject.

ExpressionProperty

ReturnsorsetsaStringthatrepresentstheexpressionusedtocalculatethespecifiedcalculatedfieldorcalculatedtotal.TheexpressionmustbecompatiblewiththeJetexpressionservice.Read/write.

expression.Expression

expressionRequired.AnexpressionthatreturnsaoneoftheobjectsintheAppliesTolist.

RemarksTheExpressionpropertywillreturnablankstringifitisnotusedwithacalculatedfieldorcalculatedtotal.

ExampleThefollowingexampledisplaysthecurrentexpressionusedforacalculatedfieldnamed"Variance"inPivotTable1.WhenyouedittheexpressionandthenclickOK,thenewexpressionisassignedtotheVariancefield.

SubChange_Expression()

DimvwViewDimcfCalcFieldDimstrCurrentExpressionDimstrNewExpression

SetvwView=PivotTable1.ActiveView

'Setavaribletothecalculatedfield.SetcfCalcField=_vwView.Fieldsets("Variance").Fields("Variance")

'Setavariabletothecurrentexpressionusedinthe'Variancefield.strCurrentExpression=cfCalcField.Expression

'Displayaninputboxthatcontainsthecurrentexpressionforthe'Variancefield.EdittheexpressionandthenclickOK.strNewExpression=InputBox("Edittheexpressionusedforthecalculated"&_"fieldandthenclickOK.",,strCurrentExpression)

'SettheexpressionusedtocalculatetheVariancefieldtothe'expressionenteredintheinputbox.cfCalcField.Expression=strNewExpression

EndSub

ExtrudeAngleProperty

ReturnsorsetsaDoublespecifyingthedirectionofextrusionforathree-dimensionalchart.ThispropertyisvalidonlyiftheProjectionModepropertyofthecharthasbeensettochProjectionModeOrthographic.Validvaluesrangefrom0to360.Thedefaultvalueis45.Read/write.

expression.ExtrudeAngle

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthensetstheprojectionmodeofthechart.

SubSetExtrudeAngle()

Dimcht3DColumnDimchConstants

SetchConstants=Chartspace1.Constants

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3-DColumnchart.cht3DColumn.Type=chChartTypeColumnClustered3D

'Settheprojectionmodetoorthographic.cht3DColumn.ProjectionMode=chConstants.chProjectionModeOrthographic

'Settheextrusionangle.cht3DColumn.ExtrudeAngle=75

EndSub

FieldProperty

ReturnsaPivotFieldobjectthatrepresentsthefieldassociatedwiththespecifiedmemberortotal.

expression.Field

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

FieldLabelBackColorProperty

Returnsorsetsthebackcolorusedforfieldlabelsforrows,columns,andfilters.Thedefaultvalueis25%gray.Read/writeVariant.

expression.FieldLabelBackColor

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

FieldLabelFontProperty

ReturnsaPivotFontobjectthatrepresentsthefieldlabelfontforrows,columns,andfilters.Read-only.

expression.FieldLabelFont

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

FieldLabelForeColorProperty

Returnsorsetstheforegroundcolorusedforfieldlabelsforrows,columns,andfilters.Read/writeVariant.

expression.FieldLabelForeColor

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

FieldLabelHeightProperty

Returnstheheightofthefieldlabelsforrows,columns,andfilters.Read-onlyLong.

expression.FieldLabelHeight

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

FieldsProperty

ReturnsthePivotFieldscollectionforthespecifiedfieldset.

expression.Fields

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

FieldSetProperty

ReturnsaPivotFieldSetobjectthatrepresentsthefieldsettowhichthespecifiedfieldbelongs.

expression.FieldSet

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

FieldSetsProperty

ReturnsaPivotFieldSetsobjectthatcontainsthefieldsetsassociatedwiththespecifiedaxisorview.

expression.FieldSets

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ShowAll

FieldTypeProperty

Returnsthefieldtypeforthespecifiedfield.Read-onlyDscFieldTypeEnum.

expression.FieldType

expressionRequired.AnexpressionthatreturnsaPageFieldproperty.

ShowAll

FillTypeProperty

ReturnsaChartFillTypeEnumconstantindicatingthetypeoffillusedforthespecifiedChInteriorobject.Read-only.

expression.FillType

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksYoucanusethefollowingmethodstosetthetypeoffillforaChInteriorobject:SetOneColorGradient,SetPatterned,SetPresetGradient,SetSolid,SetTextured,andSetTwoColorGradient.

FilterProperty

ReturnstheADOfilterstringfortherecordsetthatcorrespondstothedataaccesspage.Read/writeVariant.

expression.Filter

expressionRequired.AnexpressionthatreturnsaDataPageobject.

FilterAxisProperty

PivotDataobject:ReturnsaPivotResultFilterAxisobjectthatrepresentsthefilteraxis.

PivotViewobject:ReturnsaPivotFilterAxisobjectthatrepresentsthefilteraxis.

expression.FilterAxis

expressionRequired.AnexpressionthatreturnsaPivotDataorPivotViewobject.

FilterCaptionProperty

ReturnsaStringthatrepresentsthecaptiondisplayedjustbelowafieldsetonthefilteraxis.Read-only.

expression.FilterCaption

expressionRequired.AnexpressionthatreturnsaPivotFieldSetobject.

RemarksIftheuserhasselectedonlyoneiteminthespecifiedfield,thispropertywillreturnthatitem.Iftheuserhasselectedmultipleitemsinthefield,thispropertywillmostlikelyreturn"(MultipleItems)".

FilterContextProperty

ReturnsaPivotFieldobjectthatrepresentsthecontextbywhichtheconditionalfilterwillbeevaluated.

expression.FilterContext

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyouapplyaconditionalfiltertoafield,thefiltercanapplytothatfield,oroneofitsparentfieldsinthefieldset.Forexample,assumethatyourPivotTablelistcontainsafieldsetnamedStore.TheStorefieldsetcontainsthefollowingfields:Country,Region,City,andStoreNumber.TheCountryfieldisaparenttotheRegionfield,theRegionfieldisaparenttotheCityfield,andtheCityfieldisaparenttotheStoreNumberfield.

Nowyouwanttofindthetopfivemostprofitablecities.IfyousetthispropertytotheCityfield,thenthetopfivemostprofitablecitieswillbedisplayedinthePivotTablelist.IfyousetthispropertytotheRegionfield,thenthetopfivecitieswillbereturnedforeachregion.

Settingthispropertytoachildofthefieldthatyouareapplyingaconditionalfiltertowillresultinarun-timeerror.Forexample,youcannotsetthispropertytotheStoreNumberfieldwhenyouareapplyingaconditionalfiltertotheCityfield.

ExampleThisexampledisplaystheleastprofitablecityineachstate.

SubLeastProfitableByState()

DimptViewDimptConstantsDimfldFilterField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTablelist.SetptView=PivotTable1.ActiveView

'Setavariabletothefieldthatistobefiltered.SetfldFilterField=PivotTable1.ActiveData.RowAxis.Fields("StoreCity")

'Filterthestoresbasedonprofit.SetfldFilterField.FilterOn=ptView.Totals("Profit")

'Setthefunctionusedtofilterthestores.fldFilterField.FilterFunction=ptConstants.plFilterFunctionBottomCount

'Displaytheleastprofitablestore.fldFilterField.FilterFunctionValue=1

'Setthecontextofthefilter.Althoughwearefilteringbasedon'theStoreCityfield,settingthefiltercontexttotheStoreState'fieldmeansthattheleastprofitablestorefromeachstatewillbe'displayed.SetptView.FieldSets("Store").Fields("StoreCity").FilterContext=_

ptView.FieldSets("Store").Fields("StoreState")

EndSub

FilterCrossJoinsProperty

ReturnsorsetsaBooleanthatdetermineshowthePivotTablecontrolprocessesemptymemberswhenretrievingthedataforthecurrentview.ThedefaultvalueisTrue.Read/write.

expression.FilterCrossJoins

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksInmostcases,donotwanttosetthispropertytoFalse.However,ifyourOLAPcubecontainsafieldsetwherethetopmemberisempty,thenyoumaywanttosetthispropertytoFalse.

ShowAll

FilterFunctionProperty

FilterFunctionpropertyasitappliestothePivotFieldobject.

FilterFunctionpropertyasitappliestotheCriteriaobject.

FilterFunctionValueProperty

ReturnsorsetsaVariantrepresentingthevalueusedtofilterafield.ThetypeofvaluewillvarybasedonthecurrentsettingoftheFilterFunctionproperty.Usethefollowingtabletodetermineanappropriatevalueforthisproperty.Read/write.

FilterFunctionsetting AppropriatevaluerangeplFilterFunctionBottomCount Integervaluerepresentinghowmany

ofthebottommembersthatyouwanttodisplay.

plFilterFunctionBottomPercent Doublevaluebetween0and1representingthepercentageofmembersthatyouwanttodisplay.

plFilterFunctionBottomSumplFIlterFunctionNoneplFilterFunctionTopCount Integervaluerepresentinghowmany

ofthetopmembersthatyouwanttodisplay.

plFilterFunctionTopPercent Doublevaluebetween0and1representingthepercentageofmembersthatyouwanttodisplay.

plFilterFunctionTopSum

expression.FilterFunctionValue

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ExampleThisexampleappliesaconditionalfiltertotheStoreCityfieldbasedontheProfittotal.Thethreemostprofitablestoresaredisplayed.

SubTopThreeStores()

DimptViewDimptConstantsDimfldFilterField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTablelist.SetptView=PivotTable1.ActiveView

'Setavariabletothefieldthatistobefiltered.SetfldFilterField=PivotTable1.ActiveData.RowAxis.Fields("StoreCity")

'Filterthestoresbasedonprofit.SetfldFilterField.FilterOn=ptView.Totals("Profit")

'Setthefunctionusedtofilterthestores.fldFilterField.FilterFunction=ptConstants.plFilterFunctionTopCount

'Displaythethreemostprofitablestores.fldFilterField.FilterFunctionValue=3

EndSub

FilterModeProperty

TrueifanyworksheetrowsarecurrentlyhiddenbyAutoFiltercriteria.ThedefaultvalueisFalse.Read-onlyBoolean.

expression.FilterMode

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

RemarksIftheAutoFilterdrop-downarrowsarevisiblebutnorowsarecurrentlyfiltered(allrowsarevisible),theAutoFilterModepropertyisTrueandtheFilterModepropertyisFalse.

ExampleThisexampleturnsontheAutoFilterfortherangeA1:C20,setsfiltersforcolumnsAandC,andthenappliesthefilters.TheFilterModepropertyreturnsFalseuntiltheAutoFiltercriteriahasbeenappliedtothelist.

SubApply_AutoFilter()DimafFiltersDimafCol1DimafCol3'TurnonAutoFilter.Spreadsheet1.Worksheets("Sheet1").Range("A1:C20").AutoFilter'SetavariabletotheAutoFilterobject.SetafFilters=Spreadsheet1.Worksheets("sheet1").AutoFilterSetafCol1=afFilters.Filters(1)SetafCol3=afFilters.Filters(3)'AddacriteriathatexcludesbluefromcolumnA.afCol1.Criteria.Add"blue"'AddacriteriathatexcludesgreenfromcolumnA.afCol1.Criteria.Add"green"'Addacriteriathatexcludesyellowfromcolumnc.afCol3.Criteria.Add"yellow"'Atthispoint,theFilterModepropertyisFalse'becausetheAutoFiltercriteriahasnotbeenapplied.MsgBoxSpreadsheet1.Worksheets("Sheet1").FilterMode

'Applythecriteria.afFilters.Apply'TheFilterModepropertyisnowTruesinceyou'havehiddenseveralrowsinthelist.MsgBoxSpreadsheet1.Worksheets("Sheet1").FilterModeEndSub

FilterOnProperty

ReturnsaPivotTotalobjectthatrepresentsthetotaltousewhenconditionallyfilteringafield.

expression.FilterOn

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ExampleThisexampleappliesaconditionalfiltertotheStoreCityfieldbasedontheProfittotal.Thethreemostprofitablestoresaredisplayed.

SubTopThreeStores()

DimptViewDimptConstantsDimfldFilterField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTablelist.SetptView=PivotTable1.ActiveView

'Setavariabletothefieldthatistobefiltered.SetfldFilterField=PivotTable1.ActiveData.RowAxis.Fields("StoreCity")

'Filterthestoresbasedonprofit.SetfldFilterField.FilterOn=ptView.Totals("Profit")

'Setthefunctionusedtofilterthestores.fldFilterField.FilterFunction=ptConstants.plFilterFunctionTopCount

'Displaythethreemostprofitablestores.fldFilterField.FilterFunctionValue=3

EndSub

FilterOnScopeProperty

Thispropertyestablishesthescopethatisusedwhenconditionallyfilteringafield.YoucanpassaStringcontainingtheuniquenameofamemberoranarrayofuniquenamesofmembers.ReturnsaVariantarraycontainingPivotMemberobjects.Read/write.

expression.FilterOnScope

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksThescopeisbasedononeormoremembersofadifferentfieldthanthefieldthatisbeingfiltered.Forexample,youmaywanttoapplyafiltertotheCustomerfield,whichhasbeenaddedtotherowaxisofyourPivotTablelist,todisplaythethreecustomerstowhomyouhavemadethemostsales.Todothis,yousettheFilterFunctionpropertytoplFilterFunctionTopCount,theFilterFunctionValuepropertyto3,andtheFilterOnpropertytotheTotalSalestotal.ThePivotTablelistdisplaysyourthreebestcustomers.

Ifyouneedtonarrowyourquerytoamorespecificsetofcustomers,thenyouwouldusetheFilterOnScopeproperty.IfyouwanttoseetheyourtopcustomersintheSoutheastregion,thenyouwouldsettheFilterOnScopepropertytoanexpressionthatevaluatestotheSoutheastmemberintheRegionfield.

ExampleThisexampledisplayesthetwotop-sellingproductsinCanada.

SubDisplayTopTwoCanadianSellers()

DimobjPivotViewDimobjPivotDataDimfldProductName

'SetavariabletotheactiveviewofthePivotTable.SetobjPivotView=PivotTable1.ActiveView

'SetavariabletotheactivedataofthePivotTable.SetobjPivotData=PivotTable1.ActiveData

'SetavariabletotheProductNamefield,whichhasbeen'addedtotherowaxisofthePivotTablelist.SetfldProductName=objPivotData.RowAxis.Fields("ProductName")

'ThefollowingtwolinesofcodesetthePivotTablelisttofilterforthe'top2items.fldProductName.FilterFunction=PivotTable1.Constants.plFilterFunctionTopCountfldProductName.FilterFunctionValue=2

'FilterbasedontheUnitSalestotal.SetfldProductName.FilterOn=objPivotView.Totals("UnitSales")

'SetthefilterscopetoincludeonlysalesinCanada.fldProductName.FilterOnScope=objPivotView.FieldSets("Store").Member.ChildMembers("Canada").UniqueName

EndSub

FiltersProperty

ReturnstheFilterscollectionforthespecifiedAutoFilter.TheFilterscollectioncontainsoneFilterobjectforeachcolumninthefilteredrange.Read-only.

expression.Filters

expressionRequired.AnexpressionthatreturnsanAutoFilterobject.

ExampleThisexampleturnsontheAutoFilterfortherangeA1:C20,setsfiltersforcolumnsAandC,andthenappliesthefilters.

SubApply_AutoFilter()DimafFiltersDimafCol1DimafCol3'TurnonAutoFilter.Spreadsheet1.Worksheets("Sheet1").Range("A1:C20").AutoFilter'SetavariabletotheAutoFilterobject.SetafFilters=Spreadsheet1.Worksheets("sheet1").AutoFilterSetafCol1=afFilters.Filters(1)SetafCol3=afFilters.Filters(3)'AddacriteriathatexcludesbluefromcolumnA.afCol1.Criteria.Add"blue"'AddacriteriathatexcludesgreenfromcolumnA.afCol1.Criteria.Add"green"'Addacriteriathatexcludesyellowfromcolumnc.afCol3.Criteria.Add"yellow"'Applythecriteria.afFilters.ApplyEndSub

ShowAll

FindAxisMemberProperty

Findsanaxismember,givenareferencetothemember.ReturnsaPivotAxisMemberobject.

expression.FindAxisMember(Path,Format)

expressionRequired.AnexpressionthatreturnsaPivotAxisMemberobject.

PathRequiredString.Avariableorstringthatcontainsareferencetothemembertofind.

FormatRequiredPivotMemberFindFormatEnum.IndicatestheformatusedforthePathargument.

RemarksIftherequestedmemberisnotfound,aPivotAxisMemberobjectwiththeIsValidpropertysettoFalseisreturned.Thisallowsyoutorefertoamemberthatmightlaterbeaddedtotheschema.

Thispropertycanbeusedtofindamemberfromthetopmemberofthespecifiedaxis.UsetheMemberproperty(PivotAxisMember.Axis.Member)toreturnthetopmemberofanaxis.

ShowAll

FindColumnMemberProperty

Findsacolumnmember,givenareferencetothemember.ReturnsaPivotColumnMemberobject.

expression.FindColumnMember(Path,Format)

expressionRequired.AnexpressionthatreturnsaaPivotColumnMemberobject.

PathRequiredString.Avariableorstringthatcontainsareferencetothemembertofind.

FormatRequiredPivotMemberFindFormatEnum.IndicatestheformatusedforthePathargument.

RemarksIftherequestedmemberisnotfound,aPivotColumnMemberobjectwiththeIsValidpropertysettoFalseisreturned.Thisallowsyoutorefertoamemberthatmightlaterbeaddedtotheschema.

Thispropertycanbeusedtofindamemberfromthetopmemberofthecolumnaxis.UsetheMemberpropertytoreturnthetopmemberofthecolumnaxis.

ShowAll

FindMemberProperty

FindMemberpropertyasitappliestothePivotFieldSetobject.

FindMemberpropertyasitappliestothePivotAxisMember,PivotColumnMember,PivotMember,PivotPageMember,andPivotRowMemberobjects.

RemarksIftherequestedmemberisnotfound,aPivotMemberobjectwiththeIsValidpropertysettoFalseisreturned.Thisallowsyoutorefertoamemberthatmightlaterbeaddedtotheschema.

ExampleThisexampleattemptstofindaspecificwarehouseintheWarehousefieldset.Theuserisalertedifthespecifiedwarehouseisnotfound.

SubFindWarehouse()

DimptViewDimptConstantsDimfsWarehouseDimpmFound

SetptConstants=PivotTable1.Constants

'Setavariabletotheactiveview.SetptView=PivotTable1.ActiveView

'SetavariabletotheWarehousefieldset.SetfsWarehouse=ptView.FieldSets("Warehouse")

'SetavariabletotheresultsoftheFindMemberproperty.SetpmFound=fsWarehouse.FindMember("QualityDistribution,Inc.",ptConstants.plFindFormatMember)

'Checktoseeifthememberwasfound.IfpmFound.IsValid=FalseThen

'Alerttheuserifthememberwasnotfound.MsgBox"Thespecifiedmemberdoesnotexist."

EndIf

EndSub

ShowAll

FindPageMemberProperty

Findsapagemember,givenareferencetothemember.ReturnsaPivotPageMemberobject.

expression.FindPageMember(Path,Format)

expressionRequired.AnexpressionthatreturnsaPivotPageMemberobject.

PathRequiredString.Avariableorstringthatcontainsareferencetothemembertothemembertofind.

FormatRequiredPivotMemberFindFormatEnum.IndicatestheformatusedforthePathargument.

RemarksIftherequestedmemberisnotfound,aPivotPageMemberobjectwiththeIsValidpropertysettoFalseisreturned.Thisallowsyoutorefertoamemberthatmightlaterbeaddedtotheschema.

Thispropertycanbeusedtofindamemberfromthetopmemberofthepageaxis.UsetheMemberpropertytoreturnthetopmemberofthepageaxis.

ShowAll

FindRowMemberProperty

Findsarowmember,givenareferencetothemember.ReturnsaPivotRowMemberobject.

expression.FindRowMember(Path,Format)

expressionRequired.AnexpressionthatreturnsaPivotRowMemberobject.

PathRequiredString.Avariableorstringthatcontainsareferencetothemembertofind.

FormatRequiredPivotMemberFindFormatEnum.IndicatestheformatusedforthePathargument.

RemarksIftherequestedmemberisnotfound,aPivotRowMemberobjectwiththeIsValidpropertysettoFalseisreturned.Thisallowsyoutorefertoamemberthatmightlaterbeaddedtotheschema.

FirstSectionProperty

ReturnsaSectionobjectthatrepresentsthefirstsectiononthespecifieddataaccesspage.Read-only.

expression.FirstSection

expressionRequired.AnexpressionthatreturnsaDataPageobject.

FirstSliceAngleProperty

Returnsorsetstheangleofthefirstpie-chartordoughnut-chartslice,indegrees(clockwisefromvertical).Appliesonlytopieanddoughnutcharts.Read/writeLong.

expression.FirstSliceAngle

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexamplesetstheangleofthefirstpie-chartordoughnut-chartsliceto45degrees.Charts(0)mustrefertoapieordoughnutchart.

ChartSpace1.Charts(0).FirstSliceAngle=45

FloorProperty

ReturnsaChSurfaceobjectthatrepresentsthefloorofathree-dimensionalchart.UsethepropertiesandmethodsofthereturnedChSurfaceobjecttoformatthefloorofthespecifiedchart.

expression.Floor

expressionRequired.AnexpressionthatreturnsaChPlotAreaobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthenformatsthebackwall,sidewall,andfloorofthechart.

SubFormatWallsFloor()

Dimcht3DColumnDimchConstantsDimpaPlotArea

SetchConstants=Chartspace1.Constants

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3DColumnchart.cht3DColumn.Type=chConstants.chChartTypeColumnClustered3D

'Setavariabletotheplotarea.SetpaPlotArea=cht3DColumn.PlotArea

'Formatthebackwallofthechart.paPlotArea.BackWall.Interior.SetSolid"Yellow"paPlotArea.BackWall.Thickness=5

'Formatthesidewallofthechart.paPlotArea.SideWall.Interior.SetSolid"Yellow"paPlotArea.SideWall.Thickness=5

'Formatthefloorofthechart.paPlotArea.Floor.Interior.SetSolid"Blue"

paPlotArea.Floor.Thickness=5

EndSub

FontProperty

ReturnsaChFont,Font,orPivotFontobjectthatrepresentsthefontforthespecifiedobject(thereturnedobjecttypedependsontheobjecttowhichthispropertyisapplied).

expression.Font

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsthenumberformatandfontfortheactivecell.

SubSetFont()

DimrngCurrentCell

SetrngCurrentCell=Spreadsheet1.ActiveCell

rngCurrentCell.NumberFormat="0.###"

rngCurrentCell.Font.Color="Blue"

rngCurrentCell.Font.Name="TimesNewRoman"

EndSub

FontNameProperty

ReturnsorsetsthenameofthefontinthespecifiedRecordNavigationControlobject.Read/writeString.

expression.FontName

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

Example

Thisexamplesetsthefontnameto"CourierNew"forcontrolRNC1.

RNC1.FontName="CourierNew"

ForeColorProperty

Returnsorsetstheforegroundcolorforthespecifiedobjectorarea.Whenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-blue(RGB)colorvalueoraStringvaluerepresentingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateanRGBcolorvalue(forexample,redisRGB(255,0,0)).Read/writeVariant.expression.ForeColor

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksThispropertyalwaysreturnsthecolorasaLongvaluerepresentinganRGBcolorvalue.

ExampleThisexamplesetsthefontsize,foregroundcolor,andbackgroundcolorforthetitlebarinPivotTable1.

SubFormat_Titlebar()DimvwViewSetvwView=PivotTable1.ActiveView'Setthebackgroundcolorofthetitlebar.vwView.Label.BackColor="DarkSalmon"'Setthefontsizeofthetitlebar.vwView.Label.Font.Size=16'Settheforegroundcolorofthetitlebar.vwView.Label.ForeColor="Sienna"EndSub

FormatProperty

ReturnsorsetsaStringthatrepresentsthenumberformattingforthespecifiedelement.Read/write.

expression.Format

expressionRequired.AnexpressionthatreturnsanElementExtensionobject.

FormatMapProperty

ReturnsaChFormatMapobjectthatrepresentstheformatmapforthespecifiedseries.

expression.FormatMap

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

FormulaProperty

Returnsorsetstheobject'sformulainA1-stylenotationandinthelanguageofthescript.Ifthecellcontainsaconstant,thispropertyreturnstheconstant.Ifthecellisempty,itreturnsanemptystring.Ifthecellcontainsaformula,theFormulapropertyreturnstheformulaasastringinthesameformatthatitwouldbedisplayediftheformulawerebeingactivelyedited(includingtheequalsign).

Ifyousetthevalueorformulaofacelltoadate,theSpreadsheetcomponentcheckstoseewhetherthatcellisalreadyformattedwithoneofthedateortimenumberformats.Ifnot,theSpreadsheetcomponentchangesthenumberformattothedefaultshortdatenumberformat.

Iftherangeisaoneortwo-dimensionalrange,youcansettheformulatoanarrayofthesamedimensions.Similarly,youcanputtheformulaintoanarray.

Settingtheformulaforamultiple-cellrangefillsallcellsintherangewiththeformula.Read/writeVariant.

expression.Formula

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplesetstheformula,columnwidth,andnumberformatforcellB5onSheet1inSpreadsheet1.

SubSetFormula()DimrngRandomNum

'SetavariabletocellB5onSheet1.SetrngRandomNum=Spreadsheet1.Worksheets("Sheet1").Range("B5")

'InsertaformulaintocellB5.rngRandomNum.Formula="=5*RAND()"

'SetthenumberformatforcellB5.rngRandomNum.NumberFormat="#.###"

'AutofitcolumnB.rngRandomNum.Columns.AutoFit

EndSub

FormulaArrayProperty

ReturnsorsetsaVariantrepresentingthearrayformulaofarange.Returns(orcanbesetto)asingleformulaoraVisualBasicarray.Ifthespecifiedrangedoesn'tcontainanarrayformula,thispropertyreturnsanullstring("").Read/write.

expression.FormulaArray

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexampleentersthearrayformula=SUM(A1:A3)incellsE1:E3ontheactiveworksheet.

Spreadsheet1.ActiveSheet.Range("E1:E3").FormulaArray=_"=SUM(A1:A3)"

FormulaLocalProperty

Returnsorsetstherangeformulainthelanguagethattheuserisworkingin.Ifthecellcontainsaconstant,thispropertyreturnstheconstant.Ifthecellisempty,itreturnsanemptystring.Ifthecellcontainsaformula,theFormulapropertyreturnstheformulaasastringinthesameformatthatitwouldbedisplayediftheformulawerebeingactivelyedited(includingtheequalsign).

Ifyousetthevalueorformulaofacelltoadate,theSpreadsheetcomponentcheckstoseewhetherthatcellisalreadyformattedwithoneofthedateortimenumberformats.Ifnot,theSpreadsheetcomponentchangesthenumberformattothedefaultshortdatenumberformat.

Iftherangeisaoneortwo-dimensionalrange,youcansettheformulatoanarrayofthesamedimensions.Similarly,youcanputtheformulaintoanarray.

Settingtheformulaforamultiple-cellrangefillsallcellsintherangewiththeformula.Read/writeVariant.

expression.FormulaLocal

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexampledisplaystheformulaintheactivecellofSpreadsheet1inthelanguageoftheuser.

MsgBoxSpreadsheet1.ActiveCell.FormulaLocal

FreezePanesProperty

SetthispropertytoTruetocreatepanesintheactiveworksheet.Thepanesarecreatedaboveandtotheleftoftheactivecell.Forexample,settingthispropertytoTruewhilecellD5istheactivecellresultsinahorizontalpanebetweenrows4and5andaverticalpanebetweencolumnsCandD.SetthispropertytoFalsetoremoveallpanesfromaworksheet.Read/writeBoolean.

expression.FreezePanes

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplecreatespanesintheactiveworksheet.

Spreadsheet1.ActiveWindow.FreezePanes=True

ShowAll

FunctionProperty

Returnsorsetsthefunctiontobeusedforgeneratingaggregatevalues.Read/writePivotTotalFunctionEnum.

expression.Function

expressionRequired.AnexpressionthatreturnsaPivotTotalobject.

RemarksTheSumoperatoristhedefaultvaluefornumericdatatypes.TheCountoperatoristhedefaultvalueforotherdatatypes.

GapDepthProperty

ReturnsorsetsaLongspecifyingtheamountofspacingalongthez-axisforadjacentdataseriesinathree-dimensionalchart.Validvaluesrangefrom0to500.Read/write.

expression.GapDepth

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksSettingthispropertytoavalueof100resultsinthegapsthatarethesamethicknessasthedataseriesseries.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthensetsthegapdepthofthechart.

SubSetGapDepth()

Dimcht3DColumnAsChChart

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3-DColumnchart.cht3DColumn.Type=chChartTypeColumn3D

'Setthegapdepth.cht3DColumn.GapDepth=75

EndSub

GapWidthProperty

Returnsorsetstheamountofspacingbetweenmarkersinadjacentcategories,asapercentageofthecolumnwidth.Avalueofzeroprovidesnospacebetweenadjacentcategorymarkers,whilepositivevaluescreateagap.Read/writeLong.

expression.GapWidth

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsthespacingbetweenmarkersinadjacentcategoriesto250points.

ChartSpace1.Charts(0).GapWidth=250

GradientDegreeProperty

ReturnsaDoubleindicatingthegradientdegreeofthespecifiedshadedfillasavaluefrom0.0(dark)through1.0(light).Read-only.

expression.GradientDegree

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksUsetheSetOneColorGradientmethodtosetthegradientdegreeforaChInteriorobject.

ShowAll

GradientStyleProperty

ReturnsaChartGradientStyleEnumconstantindicatingthegradientstyleforthespecifiedChInteriorobject.Read-only.

expression.GradientStyle

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksUsetheSetPresetGradient,SetOneColorGradientorSetTwoColorGradientmethodtosetthegradientstyleforaChInteriorobject.

ShowAll

GradientVariantProperty

ReturnsaChartGradientVariantEnumconstantindicatingtheshadevariantforthespecifiedChInteriorobject.Read-only.

expression.GradientVariant

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksUsetheOneColorGradientorTwoColorGradientmethodtosetthegradientvariantforaChInteriorobject.

GridlineColorProperty

ReturnsorsetsthegridlinecolorasanRGBvalue.Read/writeLong.

expression.GridlineColor

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThefollowingexamplesetsthegridlinecoloroftheactivewindowinSpreadsheet1toRed.

Spreadsheet1.ActiveWindow.GridlineColor=RGB(255,0,0)

ShowAll

GridlineColorIndexProperty

Returnsorsetsthegridlinecolorasanindexintothecurrentcolorpalette,orasanXlColorIndexconstant.Read/write.

expression.GridlineColorIndex

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksSetthispropertytoxlColorIndexAutomatictospecifytheautomaticcolor.

Thefollowingillustrationshowsthecolor-indexvaluesinthedefaultcolorpalette.

ExampleThisexamplesetsthegridlinecolorintheactivewindowofSpreadsheet1toblue.

Spreadsheet1.ActiveWindow.GridlineColorIndex=5

GridXProperty

Returnsorsetsthenumberofdottedgridlinesperinchonthex-axisinthespecifieddataaccesspage’sdesignerdefaultsection.Read/writeLong.

expression.GridX

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

GridYProperty

Returnsorsetsthenumberofdottedgridlinesperinchonthey-axisinthespecifieddataaccesspage’sdesignerdefaultsection.Read/writeLong.

expression.GridY

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

GroupedAutoFitProperty

Trueifthespecifiedfield'scolumnwidthissetautomaticallywhenthefieldisusedontherowaxisorthecolumnaxis.Tosetthewidthofafield'scolumn,setthepropertytoFalse.Then,settheGroupedWidthpropertyofthefieldtothedesiredwidth.ThedefaultvalueisTrue.Read/writeBoolean.

expression.GroupedAutoFit

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ExampleThisexampledisablestheGroupedAutoFitpropertyofthe"ProductName"fieldinPivotTable1andthensetsthewidthofthefieldto150pixels.

SubSet_ColumnWidth()DimfldProducts'SetavariabletotheProductNamefield.SetfldProducts=PivotTable1.ActiveView.FieldSets("ProductName").Fields(0)'SettheGroupedAutoFitfortheProductNamefield.fldProducts.GroupedAutoFit=False'SetthewidthoftheProductNamefieldto150pixels.fldProducts.GroupedWidth=150EndSub

GroupedBackColorProperty

ReturnsorsetsaVariantrepresentingthebackgroundcolorofafiledwhenithasbeengrouped.Read/write.

expression.GroupedBackColor

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).

ExampleThisexamplegroupstheAgefieldofPivotTable1.Startingatage15,anewgroupwillbecreatedforeveryfiveyearsuntilage80.Then,thefont,foreground,background,heightandalignmentoftheresultinggroupsareformatted.

SubAddGrouping()

DimvwViewDimptConstantsDimpfGroupedField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetvwView=PivotTable1.ActiveView'SetavariabletotheAgefield.SetpfGroupedField=vwView.FieldSets("Age").Fields("Age")'SettheGroupOnpropertysothattheAgefieldwillbe'groupedbytheGroupIntervalsetting.pfGroupedField.GroupOn=ptConstants.plGroupOnInterval

'Createanewgroupingforeveryfiveyears.pfGroupedField.GroupInterval=5

'Startthegroupingatage15.pfGroupedField.GroupStart=15

'Endthegroupingatage80.pfGroupedField.GroupEnd=80

'Setthefontforthefieldwhenitisgrouped.pfGroupedField.GroupedFont.Bold=True

'Settheforegroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedForeColor="Black"

'SettheBackgroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedBackColor="Blue"

'Settheheightforthefieldwhenitisgrouped.pfGroupedField.GroupedHeight=15

'Setthehorizontalalignmentforthefieldwhenitisgrouped.pfGroupedField.GroupedHAlignment=ptConstants.plHAlignRightEndSub

GroupedFontProperty

ReturnsaPivotFontobjectthatrepresentsthefontforthespecifiedfieldwhenithasbeengrouped.

expression.GroupedFont

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ExampleThisexamplegroupstheAgefieldofPivotTable1.Startingatage15,anewgroupwillbecreatedforeveryfiveyearsuntilage80.Then,thefont,foreground,background,heightandalignmentoftheresultinggroupsareformatted.

SubAddGrouping()

DimvwViewDimptConstantsDimpfGroupedField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetvwView=PivotTable1.ActiveView'SetavariabletotheAgefield.SetpfGroupedField=vwView.FieldSets("Age").Fields("Age")'SettheGroupOnpropertysothattheAgefieldwillbe'groupedbytheGroupIntervalsetting.pfGroupedField.GroupOn=ptConstants.plGroupOnInterval

'Createanewgroupingforeveryfiveyears.pfGroupedField.GroupInterval=5

'Startthegroupingatage15.pfGroupedField.GroupStart=15

'Endthegroupingatage80.pfGroupedField.GroupEnd=80

'Setthefontforthefieldwhenitisgrouped.pfGroupedField.GroupedFont.Bold=True

'Settheforegroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedForeColor="Black"

'SettheBackgroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedBackColor="Blue"

'Settheheightforthefieldwhenitisgrouped.pfGroupedField.GroupedHeight=15

'Setthehorizontalalignmentforthefieldwhenitisgrouped.pfGroupedField.GroupedHAlignment=ptConstants.plHAlignRightEndSub

GroupedForeColorProperty

ReturnsorsetsaVariantrepresentingtheforegroundcolorofafieldwhenithasbeengrouped.Usethispropertytosetthecolorofagroupeditem.Read/write.

expression.GroupedForeColor

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).

ExampleThisexamplegroupstheAgefieldofPivotTable1.Startingatage15,anewgroupwillbecreatedforeveryfiveyearsuntilage80.Then,thefont,foreground,background,heightandalignmentoftheresultinggroupsareformatted.

SubAddGrouping()

DimvwViewDimptConstantsDimpfGroupedField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetvwView=PivotTable1.ActiveView'SetavariabletotheAgefield.SetpfGroupedField=vwView.FieldSets("Age").Fields("Age")'SettheGroupOnpropertysothattheAgefieldwillbe'groupedbytheGroupIntervalsetting.pfGroupedField.GroupOn=ptConstants.plGroupOnInterval

'Createanewgroupingforeveryfiveyears.pfGroupedField.GroupInterval=5

'Startthegroupingatage15.pfGroupedField.GroupStart=15

'Endthegroupingatage80.pfGroupedField.GroupEnd=80

'Setthefontforthefieldwhenitisgrouped.pfGroupedField.GroupedFont.Bold=True

'Settheforegroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedForeColor="Black"

'SettheBackgroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedBackColor="Blue"

'Settheheightforthefieldwhenitisgrouped.pfGroupedField.GroupedHeight=15

'Setthehorizontalalignmentforthefieldwhenitisgrouped.pfGroupedField.GroupedHAlignment=ptConstants.plHAlignRightEndSub

ShowAll

GroupedHAlignmentProperty

ReturnsorsetsaPivotHAlignmentEnumconstantthatrepresentsthehorizontalalignmentofthespecifiedfieldwhenithasbeengrouped.Read/write.

expression.GroupedHAlignment

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ExampleThisexamplegroupstheAgefieldofPivotTable1.Startingatage15,anewgroupwillbecreatedforeveryfiveyearsuntilage80.Then,thefont,foreground,background,heightandalignmentoftheresultinggroupsareformatted.

SubAddGrouping()

DimvwViewDimptConstantsDimpfGroupedField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetvwView=PivotTable1.ActiveView'SetavariabletotheAgefield.SetpfGroupedField=vwView.FieldSets("Age").Fields("Age")'SettheGroupOnpropertysothattheAgefieldwillbe'groupedbytheGroupIntervalsetting.pfGroupedField.GroupOn=ptConstants.plGroupOnInterval

'Createanewgroupingforeveryfiveyears.pfGroupedField.GroupInterval=5

'Startthegroupingatage15.pfGroupedField.GroupStart=15

'Endthegroupingatage80.pfGroupedField.GroupEnd=80

'Setthefontforthefieldwhenitisgrouped.pfGroupedField.GroupedFont.Bold=True

'Settheforegroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedForeColor="Black"

'SettheBackgroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedBackColor="Blue"

'Settheheightforthefieldwhenitisgrouped.pfGroupedField.GroupedHeight=15

'Setthehorizontalalignmentforthefieldwhenitisgrouped.pfGroupedField.GroupedHAlignment=ptConstants.plHAlignRightEndSub

GroupedHeightProperty

ReturnsorsetsaLongthatrepresentstheheightofafieldwhenithasbeengrouped.Read/write.

expression.GroupedHeight

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ExampleThisexamplegroupstheAgefieldofPivotTable1.Startingatage15,anewgroupwillbecreatedforeveryfiveyearsuntilage80.Then,thefont,foreground,background,heightandalignmentoftheresultinggroupsareformatted.

SubAddGrouping()

DimvwViewDimptConstantsDimpfGroupedField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetvwView=PivotTable1.ActiveView'SetavariabletotheAgefield.SetpfGroupedField=vwView.FieldSets("Age").Fields("Age")'SettheGroupOnpropertysothattheAgefieldwillbe'groupedbytheGroupIntervalsetting.pfGroupedField.GroupOn=ptConstants.plGroupOnInterval

'Createanewgroupingforeveryfiveyears.pfGroupedField.GroupInterval=5

'Startthegroupingatage15.pfGroupedField.GroupStart=15

'Endthegroupingatage80.pfGroupedField.GroupEnd=80

'Setthefontforthefieldwhenitisgrouped.pfGroupedField.GroupedFont.Bold=True

'Settheforegroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedForeColor="Black"

'SettheBackgroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedBackColor="Blue"

'Settheheightforthefieldwhenitisgrouped.pfGroupedField.GroupedHeight=15

'Setthehorizontalalignmentforthefieldwhenitisgrouped.pfGroupedField.GroupedHAlignment=ptConstants.plHAlignRightEndSub

GroupedWidthProperty

Returnsorsetsthewidthofthespecifiedfield(pixels)whenthefieldisdisplayedontherowaxisorthecolumnaxis.Thedefaultvalueis50pixels.ThispropertyisignorediftheGroupedAutoFitpropertyforthespecifiedfieldissettoTrue.Read/writeLong.

expression.GroupedWidth

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

ExampleThisexampledisablestheGroupedAutoFitpropertyofthe"ProductName"fieldinPivotTable1andthensetsthewidthofthefieldto150pixels.

SubSet_ColumnWidth()DimfldProducts'SetavariabletotheProductNamefield.SetfldProducts=PivotTable1.ActiveView.FieldSets("ProductName").Fields(0)'SettheGroupedAutoFitfortheProductNamefield.fldProducts.GroupedAutoFit=False'SetthewidthoftheProductNamefieldto150pixels.fldProducts.GroupedWidth=150EndSub

GroupEndProperty

ReturnsorsetsaVariantrepresentingtheendingvalueofthegroupingintervalforthespecifiedfield.Read/write.

expression.GroupEnd

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksIfthespecifiedfieldcontainsvaluesgreaterthanthesettingforthisproperty,thenagrouptitled">=(GroupEnd+1)"iscreatedwhereGroupEndisthevaluespecifiedforthisproperty.Thisgroupwillcontainallvaluesthataregreaterthanthesettingforthisproperty.

IfthispropertyisnotsetorissettoEmpty,thenthelargestvalueinthefieldisusedastheendingvalue.

IfthecurrentsettingfortheGroupOnpropertyisplGroupOnPrefixChars,thenyouwillreceivearun-timeerrorwhenyousetthisproperty.

ExampleThisexamplegroupstheAgefieldofPivotTable1.Startingatage15,anewgroupwillbecreatedforeveryfiveyearsuntilage80.Then,thefont,foreground,background,heightandalignmentoftheresultinggroupsareformatted.

SubAddGrouping()

DimvwViewDimptConstantsDimpfGroupedField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetvwView=PivotTable1.ActiveView'SetavariabletotheAgefield.SetpfGroupedField=vwView.FieldSets("Age").Fields("Age")'SettheGroupOnpropertysothattheAgefieldwillbe'groupedbytheGroupIntervalsetting.pfGroupedField.GroupOn=ptConstants.plGroupOnInterval

'Createanewgroupingforeveryfiveyears.pfGroupedField.GroupInterval=5

'Startthegroupingatage15.pfGroupedField.GroupStart=15

'Endthegroupingatage80.pfGroupedField.GroupEnd=80

'Setthefontforthefieldwhenitisgrouped.pfGroupedField.GroupedFont.Bold=True

'Settheforegroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedForeColor="Black"

'SettheBackgroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedBackColor="Blue"

'Settheheightforthefieldwhenitisgrouped.pfGroupedField.GroupedHeight=15

'Setthehorizontalalignmentforthefieldwhenitisgrouped.pfGroupedField.GroupedHAlignment=ptConstants.plHAlignRightEndSub

GroupFieldProperty

ReturnsaPivotResultGroupFieldobject.Usethepropertiesofthereturnedobjecttoaccessthesourcefieldandaxispropertiesofthespecifiedaxismember.

expression.GroupField

expressionRequired.AnexpressionthatreturnsaPivotAxisMemberobject.

GroupFieldsProperty

ReturnsthePivotResultGroupFieldscollectionforthespecifiedgroupaxis.

expression.GroupFields

expressionRequired.AnexpressionthatreturnsaPivotResultGroupAxisobject.

GroupFilterControlProperty

ReturnsorsetstheIDofthelistboxorcomboboxusedtosetcurrency.Read/writeString.

expression.GroupFilterControl

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

GroupFilterFieldProperty

Returnsorsetsthefilterstringusedbythegroupfiltercontrol(thefieldonwhichthecontrolwillsetcurrency).Thisstringmustbethenameofapagefieldinthegrouplevel'srecordsource.Read/writeString.

expression.GroupFilterField

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

GroupFooterProperty

Trueifthespecifiedsectionhasafooter.Youcansetthispropertyforanybandinglevelexcepttheinnermostone.ThedefaultvalueisFalse.Read/writeBoolean.

expression.GroupFooter

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

GroupHeaderProperty

Trueifthespecifiedsectionhasaheader.ThedefaultvalueisTrue.Read/writeBoolean.

expression.GroupHeader

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

GroupingDefsProperty

ReturnstheGroupingDefscollectionforthespecifiedrecordsetdefinition.ThiscollectioncontainstheGroupingDefobjectsthatcreategroupinglevelsforthedetailrecords.

expression.GroupingDefs

expressionRequired.AnexpressionthatreturnsaRecordsetDefobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ShowAll

GroupingTotalFunctionProperty

ReturnsorsetsaChartGroupingTotalFunctionEnumconstantthatrepresentsthefunctionusedtodisplaythevaluesinagroup.Read/write.

expression.GroupingTotalFunction

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toalinechart,thenformatsthecategoryaxissothatthevaluesaregroupedbymonth.Theaveragevalueofeachmonthisdisplayedonthechart.

SubFormatTimeScaling()

DimchConstantsDimaxCategory

SetchConstants=ChartSpace1.Constants

'ChangethecharttoaLinechart.ChartSpace1.Charts(0).Type=chConstants.chChartTypeLine

'Setavariabletothecategoryaxis.SetaxCategory=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory)

'Specifythatyouwilldeterminethegroupingsettingsofthe'axis.Notethatthislineofcodeisnecessaryonlyifthe'GroupingTypepropertyfortheaxishasbeenpreviouslysetto'chAxisGroupingNone.axCategory.GroupingType=chConstants.chAxisGroupingManual

'Groupthecategoryaxisbymonth.axCategory.GroupingUnitType=chConstants.chAxisUnitMonth

'Createanewgroupingforeverymonth.axCategory.GroupingUnit=1

'Displaytheaverageoftheitemsineachgroup.

axCategory.GroupingTotalFunction=chConstants.chFunctionAvg

'Aticklabelisdisplayedforeverymonth.axCategory.TickLabelUnitType=chConstants.chAxisUnitMonth

'Atickmarkisdisplayedforeverythreemonths.axCategory.TickMarkUnitType=chConstants.chAxisUnitQuarter

EndSub

ShowAll

GroupingTypeProperty

ReturnsorsetsaChartAxisGroupingEnumconstantthatrepresentswhetherornottheitemsonachartaxisaregrouped,andifso,whetherthegroupingwasdoneautomatically.Read/write.

expression.GroupingType

expressionRequired.AnexpressionthatreturnsaChAxisobject.

RemarksTheChartcontrolautomaticallycreatesatimescaleandgroupsonthecategoryaxiswhenthefollowingconditionsaretrue:

TheChartcontroldetectsthatthecategoryinformationisadate.

TheChartcontrolisboundtoaPivotTablelist,andthePivotTablelistisnotboundtoanOLAPdatasource.

ExampleThisexampledisablestimescalingonthecategoryaxisofthefirstchartinChartspace1.

SubDisableTimeScaling()

DimchConstantsDimaxCategory

SetchConstants=ChartSpace1.Constants

'Setavariabletothecategoryaxis.SetaxCategory=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionTimescale)

'Disabletimescalingonthecategoryaxis.axCategory.GroupingType=chConstants.chAxisGroupingNone

EndSub

GroupingUnitProperty

ReturnsorsetsaLongvaluethatrepresentsthenumberofitemsinagroup.Read/write.

expression.GroupingUnit

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toalinechart,thenformatsthecategoryaxissothatthevaluesaregroupedbymonth.Theaveragevalueofeachmonthisdisplayedonthechart.

SubFormatTimeScaling()

DimchConstantsDimaxCategory

SetchConstants=ChartSpace1.Constants

'ChangethecharttoaLinechart.ChartSpace1.Charts(0).Type=chConstants.chChartTypeLine

'Setavariabletothecategoryaxis.SetaxCategory=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory)

'Specifythatyouwilldeterminethegroupingsettingsofthe'axis.Notethatthislineofcodeisnecessaryonlyifthe'GroupingTypepropertyfortheaxishasbeenpreviouslysetto'chAxisGroupingNone.axCategory.GroupingType=chConstants.chAxisGroupingManual

'Groupthecategoryaxisbymonth.axCategory.GroupingUnitType=chConstants.chAxisUnitMonth

'Createanewgroupingforeverymonth.axCategory.GroupingUnit=1

'Displaytheaverageoftheitemsineachgroup.

axCategory.GroupingTotalFunction=chConstants.chFunctionAvg

'Aticklabelisdisplayedforeverymonth.axCategory.TickLabelUnitType=chConstants.chAxisUnitMonth

'Atickmarkisdisplayedforeverythreemonths.axCategory.TickMarkUnitType=chConstants.chAxisUnitQuarter

EndSub

ShowAll

GroupingUnitTypeProperty

ReturnsorsetsaChartAxisUnitTypeEnumconstantthatrepresentshowitemsaregroupedonanaxis.

expression.GroupingUnitType

expressionRequired.AnexpressionthatreturnsaChAxisobject.

RemarksSettingthispropertysetstheGroupingTypepropertytochAxisGroupingManual.

TheChartcontrolautomaticallycreatesatimescaleandgroupsonthecategoryaxiswhenthefollowingconditionsaretrue:

TheChartcontroldetectsthatthecategoryinformationisadate.

TheChartcontrolisboundtoaPivotTablelist,andthePivotTablelistisnotboundtoanOLAPdatasource.

ExampleThisexampleconvertsthefirstchartinChartspace1toalinechart,thenformatsthecategoryaxissothatthevaluesaregroupedbymonth.Theaveragevalueofeachmonthisdisplayedonthechart.

SubFormatTimeScaling()

DimchConstantsDimaxCategory

SetchConstants=ChartSpace1.Constants

'ChangethecharttoaLinechart.ChartSpace1.Charts(0).Type=chConstants.chChartTypeLine

'Setavariabletothecategoryaxis.SetaxCategory=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory)

'Specifythatyouwilldeterminethegroupingsettingsofthe'axis.Notethatthislineofcodeisnecessaryonlyifthe'GroupingTypepropertyfortheaxishasbeenpreviouslysetto'chAxisGroupingNone.axCategory.GroupingType=chConstants.chAxisGroupingManual

'Groupthecategoryaxisbymonth.axCategory.GroupingUnitType=chConstants.chAxisUnitMonth

'Createanewgroupingforeverymonth.axCategory.GroupingUnit=1

'Displaytheaverageoftheitemsineachgroup.

axCategory.GroupingTotalFunction=chConstants.chFunctionAvg

'Aticklabelisdisplayedforeverymonth.axCategory.TickLabelUnitType=chConstants.chAxisUnitMonth

'Atickmarkisdisplayedforeverythreemonths.axCategory.TickMarkUnitType=chConstants.chAxisUnitQuarter

EndSub

ShowAll

GroupIntervalProperty

GroupIntervalpropertyasitappliestothePivotFieldobject.

GroupIntervalpropertyasitappliestotheGroupLevelandPageFieldobjects.

ExampleAsitappliestothePivotFieldobject.

GroupLevelProperty

ReturnstheGroupLevelobjectforthespecifieddataaccesspage.AGroupLevelobjectcorrespondstoarecordsetproducedbyarecordsetdefinitionorgroupingdefinition.Read-only.

expression.GroupLevel

expressionRequired.AnexpressionthatreturnsaDataPageobject.

GroupLevelsProperty

ReturnstheGroupLevelscollectionforthespecifieddatasourcecontrol.Read-only.

expression.GroupLevels

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ShowAll

GroupOnProperty

GroupOnpropertyasitappliestothePivotFieldobject.

GroupOnpropertyasitappliestotheGroupLevelandPageFieldobjects.

ExampleAsitappliestothePivotFieldobject.

GroupStartProperty

ReturnsorsetsaVariantrepresentingthestartingvalueofthegroupingintervalforthespecifiedfield.Read/write.

expression.GroupStart

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksIfthespecifiedfieldcontainsvaluessmallerthanthesettingforthisproperty,thenagroupentitled"<GroupStart"iscreatedwhereGroupStartisthevaluespecifiedforthisproperty.Thisgroupwillcontainallvaluesthataresmallerthanthesettingforthisproperty.

IfthispropertyisnotsetorissettoEmpty,thenthesmallestvalueinthefieldisusedasthestartingvalue.

IfthecurrentsettingfortheGroupOnpropertyisplGroupOnPrefixChars,thenyouwillreceivearun-timeerrorwhenyousetthisproperty.

ExampleThisexamplegroupstheAgefieldofPivotTable1.Startingatage15,anewgroupwillbecreatedforeveryfiveyearsuntilage80.Then,thefont,foreground,background,heightandalignmentoftheresultinggroupsareformatted.

SubAddGrouping()

DimvwViewDimptConstantsDimpfGroupedField

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetvwView=PivotTable1.ActiveView'SetavariabletotheAgefield.SetpfGroupedField=vwView.FieldSets("Age").Fields("Age")'SettheGroupOnpropertysothattheAgefieldwillbe'groupedbytheGroupIntervalsetting.pfGroupedField.GroupOn=ptConstants.plGroupOnInterval

'Createanewgroupingforeveryfiveyears.pfGroupedField.GroupInterval=5

'Startthegroupingatage15.pfGroupedField.GroupStart=15

'Endthegroupingatage80.pfGroupedField.GroupEnd=80

'Setthefontforthefieldwhenitisgrouped.pfGroupedField.GroupedFont.Bold=True

'Settheforegroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedForeColor="Black"

'SettheBackgroundcolorforthefieldwhenitisgrouped.pfGroupedField.GroupedBackColor="Blue"

'Settheheightforthefieldwhenitisgrouped.pfGroupedField.GroupedHeight=15

'Setthehorizontalalignmentforthefieldwhenitisgrouped.pfGroupedField.GroupedHAlignment=ptConstants.plHAlignRightEndSub

ShowAll

HAlignmentProperty

Returnsorsetsthewaydataisalignedinthespecifiedlabelortotal.Read/writePivotHAlignmentEnum.

expression.HAlignment

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

HasAbsoluteLabelsProperty

Returnsorsetswhetherthelegendentriesforpercentage-calculatedsegmentsaredisplayedasabsolutevaluesinthelegend.SetthispropertytoTrueinordertodisplaytheactualbeginningandendingvaluesforasegmentthatwascalculatedasapercentage.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasAbsoluteLabels

expressionRequired.AnexpressionthatreturnsaChSegmentobject.

ExampleThisexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreatedthatdisplaysthelargervaluesinthechartwithadarkershadeofblue.

SubWindow_Onload()

DimserSeries1DimsegSegment1AsChSegmentDimchconstants

Setchconstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;persistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=DataServer;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderDetailstable.ChartSpace1.SetDatachconstants.chDimCategories,chconstants.chDataBound,"ProductID"ChartSpace1.SetDatachconstants.chDimValues,chconstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachconstants.chDimFormatValues,chconstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.SetsegSegment1=serSeries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segSegment1.Begin.ValueType=chconstants.chBoundaryValuePercentsegSegment1.End.ValueType=chconstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto100%.segSegment1.Begin.Value=0segSegment1.End.Value=1

'Formattheinteriorofthematchingvalues.segSegment1.Begin.Interior.Color="White"segSegment1.End.Interior.Color="Blue"segSegment1.HasAutoDivisions=FalsesegSegment1.HasAbsoluteLabels=TruesegSegment1.HasDiscreteDivisions=False

EndSub

HasArrayProperty

Trueifthespecifiedcellispartofanarrayformula.Read-onlyVariant.

expression.HasArray

expressionRequired.AnexpressionthatreturnsaRangeobject.

RemarksUsetheCurrentArraypropertytodeterminethethecellsthatarepartofthecurrentarray.

ExampleThisexampledetermineswhethertheactivecellinSpreadsheet1ispartofanarray.Isso,thearrayisselected.

IfSpreadsheet1.ActiveCell.HasArrayThen_Spreadsheet1.ActiveCell.CurrentArray.Select

HasAutoAspectRatioProperty

Falseiftheaspectratioofthespecifiedcharthasbeenmodified.SetthispropertytoTruetorestorethespecifiedcharttoit'sdefaultaspectratio.Read-writeBoolean.

expression.HasAutoAspectRatio

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleresetsthefirstchartinChartspace1toitsdefaultaspectratio.

Chartspace1.Charts(0).HasAutoAspectRatio=True

HasAutoCaptionProperty

Trueifthenameforthespecifiedtrendlineisgeneratedautomaticallyfromthetrendlinetypeandseriesindex("Poly.(Series1)",forexample).Settingthetrendline’sCaptionpropertysetsthispropertytoFalse.Read/writeBoolean.

expression.HasAutoCaption

expressionRequired.AnexpressionthatreturnsaChTrendlineobject.

ExampleThisexamplesetsthecaptionforthespecifiedtrendlinecaptionifthecaptioniscurrentlysettobegeneratedautomatically.NotethatSeriesCollection(0)mustrefertoaseriesthatalreadyhasatrendline.

SubSetCaption()DimserZeroDimtrndlineSetserZero=ChartSpace1.Charts(0).SeriesCollection(0)serZero.Line.Color="red"Settrndline=serZero.Trendlines(0)Iftrndline.HasAutoCaptionThentrndline.Caption="datatrend"EndSub

HasAutoChartDepthProperty

Falseifthedepthofthespecifiedcharthasbeenmodified.SetthispropertytoTruetorestorethespecifiedcharttoitsdefaultdepth.Read-writeBoolean.

expression.HasAutoChartDepth

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleresetsthefirstchartinChartspace1toit'sdefaultdepth.

Chartspace1.Charts(0).HasAutoChartDepth=True

HasAutoDivisionsProperty

Returnsorsetswhetherdivisionsareautomaticallycreatedforthespecifiedsegment.ThedefaultvalueisTrue.Read/writeBoolean.

expression.HasAutoDivisions

expressionRequired.AnexpressionthatreturnsaChSegmentobject.

ExampleThisexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreatedthatdisplaysthelargervaluesinthechartwithadarkershadeofblue.

SubWindow_Onload()

DimserSeries1DimsegSegment1AsChSegmentDimchconstants

Setchconstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;persistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=DataServer;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderDetailstable.ChartSpace1.SetDatachconstants.chDimCategories,chconstants.chDataBound,"ProductID"ChartSpace1.SetDatachconstants.chDimValues,chconstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachconstants.chDimFormatValues,chconstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.SetsegSegment1=serSeries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segSegment1.Begin.ValueType=chconstants.chBoundaryValuePercentsegSegment1.End.ValueType=chconstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto100%segSegment1.Begin.Value=0segSegment1.End.Value=1

'Formattheinteriorofthematchingvalues.segSegment1.Begin.Interior.Color="White"segSegment1.End.Interior.Color="Blue"

segSegment1.HasAutoDivisions=False

segSegment1.HasAbsoluteLabels=True

segSegment1.HasDiscreteDivisions=False

EndSub

HasAutoMajorUnitProperty

Trueifthemajorunitforthespecifiedaxisisdeterminedautomatically.ThedefaultvalueisTrue.Youshouldusethispropertyonlyforvalueaxes.Read/writeBoolean.

expression.HasAutoMajorUnit

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetsthemajorunitforthespecifiedaxisifthemajorunitiscurrentlysettobedeterminedautomatically.

SubSetMajorUnit()DimchtConstantsdimaxsSetchtConstants=ChartSpace1.ConstantsSetaxs=ChartSpace1.Charts(0).Axes(chtConstants.chAxisPositionValue)Ifaxs.HasAutoMajorUnitThenaxs.MajorUnit=5000EndSub

HasAutoMaximumProperty

Trueifthemaximumscalevalueforthespecifiedaxisissettobedeterminedautomatically.ThedefaultvalueisTrue.Read/writeBoolean.

expression.HasAutoMaximum

expressionRequired.AnexpressionthatreturnsaChScalingobject.

ExampleThisexamplesetsthemaximumscalevalueforthespecifiedaxisifthemaximumvalueiscurrentlysettobedeterminedautomatically.

SubSetScale()DimchConstantsdimaxisScaleSetchConstants=ChartSpace1.ConstantsSetaxisScale=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).ScalingIfaxisScale.HasAutoMaximumThenaxisScale.Maximum=50000EndSub

HasAutoMinimumProperty

Trueiftheminimumscalevalueforthespecifiedaxisissettobedeterminedautomatically.ThedefaultvalueisTrue.Read/writeBoolean.

expression.HasAutoMinimum

expressionRequired.AnexpressionthatreturnsaChScalingobject.

ExampleThisexamplesetstheminimumscalevalueforthespecifiedaxisiftheminimumvalueiscurrentlysettobedeterminedautomatically.

SubSetScaling()DimchConstantsDimaxisScaleSetchConstants=ChartSpace1.ConstantsSetaxisScale=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).ScalingIfaxisScale.HasAutoMinimumThenaxisScale.Minimum=10EndSub

HasAutoMinorUnitProperty

Trueiftheminorunitforthespecifiedaxisissettobedeterminedautomatically.ThedefaultvalueisTrue.Youshouldusethispropertyonlyforvalueaxes.Read/writeBoolean.

expression.HasAutoMinorUnit

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetstheminorunitforthespecifiedaxistoincrementsof500iftheunitiscurrentlysettobedeterminedautomatically.

SubSetMinorUnit()DimchConstantsDimaxsSetchConstants=ChartSpace1.ConstantsSetaxs=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)Ifaxs.HasAutoMinorUnitThenaxs.MinorUnit=500EndSub

HasBubbleSizeProperty

Trueifeverydatalabelforthespecifiedseriesorchartcurrentlydisplaysitsbubblesize.ThedefaultvalueisFalse.Notethatthispropertyisavailableonlyforbubblecharts.Read/writeBoolean.

expression.HasBubbleSize

expressionRequired.AnexpressionthatreturnsaChDataLabelsobject.

RemarksDatalabelcomponentsarealwaysdisplayedinthefollowingorder:[SeriesName][CategoryName][Value][BubbleSize][Percentage].

ExampleThisexamplecausesthedatalabelsforthespecifiedseriestodisplaytheirbubblesize.NotethatCharts(0)mustrefertoabubblechart.

SubDisplayLabels()DimdlBubbleLabelsSetdlBubbleLabels=ChartSpace1.Charts(0).SeriesCollection(0).DataLabelsCollection.AdddlBubbleLabels.HasBubbleSize=TrueEndSub

HasCategoryNameProperty

Trueifeverydatalabelforthespecifiedseriesorchartcurrentlydisplaysitscategorynameorlabel.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasCategoryName

expressionRequired.AnexpressionthatreturnsaChDataLabelsobject.

RemarksDatalabelcomponentsarealwaysdisplayedinthefollowingorder:[SeriesName][CategoryName][Value][BubbleSize][Percentage]

ExampleThisexamplecausesthedatalabelsforthespecifiedseriestodisplaytheircategoryandseriesnames.

SubShowLabels()Dimdl

Setdl=ChartSpace1.Charts(0).SeriesCollection(0).DataLabelsCollection(0)

'Displaythecategorynames.dl.HasCategoryName=True'Displaytheseriesnames.dl.HasSeriesName=TrueEndSub

HasDetailsProperty

Trueifdetailrecordscanbedisplayedforagivencell;Falseifdetailrecordsarenotavailablefordisplay.Thispropertyisautomaticallyresetwheneverthedataisrequeried.IfthispropertyissettoFalse,theexpansionindicatorsarenotdisplayedforinnermembers.ThispropertyisalwayssettoFalseiftheproviderismultidimensional.Read-onlyBoolean.

expression.HasDetails

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

HasDiscreteDivisionsProperty

Returnsorsetsthemethodusedtointerpolatetheformattingofthespecifiedsegmentbetweenitsbeginningandendingvalues.SettingthispropertytoTruecausestheChartcontroltoassignanumberofdivisionstothesegment.SettingthispropertytoFalsecausestheChartcontroltointerpolatebetweenthebeginningandendingvaluesofthesegmentwithoutcreatingdiscretedivisionsinformatting.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasDiscreteDivisions

expressionRequired.AnexpressionthatreturnsaChSegmentobject.

RemarksToillustratethedifferenceswhensettingthispropertytoTrueorFalse,assumethatyousetthefollowingpropertiesforasegment:

.Begin.Value=10

.Begin.Interior.Color="White"

.End.Value=50

.End.Interior.Color="Green"

WhensettingthispropertytoTrue,theChartcontrolwouldcreateseveraldivisionswhichcontainadifferentinterpolationoftheabovecolorsettings.However,pointsthatareveryclosetoeachotherinvaluecanbeformattedverydifferentlybecauseeachpointisinadifferentdivision.Apointwithavalueof24maybewhitewhileapointwithavalueof25maybeafairlydarkshadeofgreen,becauseadivisionwascreatedbetween24and25.SettingthispropertytoFalseresultsinamoregradualinterpolationbetweenwhiteandgreen.

ExampleThisexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreatedthatdisplaysthelargervaluesinthechartwithadarkershadeofblue.

SubWindow_Onload()

DimserSeries1DimsegSegment1AsChSegmentDimchconstants

Setchconstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;persistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=DataServer;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderDetailstable.ChartSpace1.SetDatachconstants.chDimCategories,chconstants.chDataBound,"ProductID"ChartSpace1.SetDatachconstants.chDimValues,chconstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachconstants.chDimFormatValues,chconstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.SetsegSegment1=serSeries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segSegment1.Begin.ValueType=chconstants.chBoundaryValuePercentsegSegment1.End.ValueType=chconstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto100%.segSegment1.Begin.Value=0segSegment1.End.Value=1

'Formattheinteriorofthematchingvalues.segSegment1.Begin.Interior.Color="White"segSegment1.End.Interior.Color="Blue"

segSegment1.HasAutoDivisions=False

segSegment1.HasAbsoluteLabels=True

segSegment1.HasDiscreteDivisions=False

EndSub

HasFormulaProperty

Trueifallcellsintherangecontainformulas,Falseifnonecontainformulas,andNullifsomecellscontainformulasandothersdonot.Read-onlyVariant.UsetheIsNullfunctiontodetermineifthereturnvalueisNull.

expression.HasFormula

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplerecalculatestheactiveworksheetifanycellinthecurrentlyselectedrangecontainsaformula.

SubCalcIfSelectionHasFormulas()DimvntHasFormulaDimrngCurrentSetrngCurrent=Spreadsheet1.Selection'SetavariabletotheHasFormulaproperty'forthecurrentselection.vntHasFormula=rngCurrent.HasFormulaIfIsNull(vntHasFormula)Then'Calculatetheactiveworksheetifthe'selectioncontainsoneormoreformulas.Spreadsheet1.ActiveSheet.CalculateElseIfvntHasFormulaThen'Calculatetheactiveworksheetifall'selectedcellscontainaformula.Spreadsheet1.ActiveSheet.CalculateEndIfEndSub

HasLegendProperty

Trueifthespecifiedcharthasalegend.Read/writeBoolean.

expression.HasLegend

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexamplesetsthespecifiedcharttohavealegend.

ChartSpace1.Charts(0).HasLegend=True

HasMajorGridlinesProperty

Trueifthespecifiedaxishasmajorgridlines.Notethatanyaxiscanhavegridlines.Read/writeBoolean.

expression.HasMajorGridlines

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleturnsonthemajorandminorgridlinesonthefirstchartinChartSpace1.

SubEnableGridlines()DimchConstantsDimaxValueAxisSetchConstants=ChartSpace1.Constants'Setavariabletorefertothevalueaxis.SetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)'Enablethemajorgridlinesonthevalueaxis.axValueAxis.HasMajorGridlines=True'Enablethemajorgridlinesonthevalueaxis.axValueAxis.HasMinorGridlines=TrueEndSub

HasMinorGridlinesProperty

Trueifthespecifiedaxishasminorgridlines.Notethatanyaxiscanhavegridlines.Read/writeBoolean.

expression.HasMinorGridlines

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleturnsonthemajorandminorgridlinesonthefirstchartinChartSpace1.

SubEnableGridlines()DimchConstantsDimaxValueAxisSetchConstants=ChartSpace1.Constants'Setavariabletorefertothevalueaxis.SetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)'Enablethemajorgridlinesonthevalueaxis.axValueAxis.HasMajorGridlines=True'Enablethemajorgridlinesonthevalueaxis.axValueAxis.HasMinorGridlines=TrueEndSub

HasMultipleChartsProperty

ReturnsorsetsaBooleanthatindicateswhetherthespecifiedChartSpacecontainsmultiplecharts.ThedefaultvalueisFalse.Read/write.

expression.HasMultipleCharts

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

HasPassiveAlertsProperty

Returnsorsetswhetherpassivealertsaretobeusedwhenanon-criticalerrorinencountered.ThedefaultvalueisTrue.Read/writeBoolean.

expression.HasPassiveAlerts

expressionRequired.AnexpressionthatreturnsaChartspaceobject.

RemarksPassivealertsarepresentedasasmallexclamationsymbolinthelowerleftcornerofthechartcontrol.Clickingthesymboldisplaysmoreinformationaboutthenon-criticalerrorthathasoccurred.ThisfeatureissimilartotheMicrosoftInternetExplorerfeatureofdisplayinganalertsymbolinthestatusbarwhenscripterrorshaveoccurred.

HasPercentageProperty

Trueifeverydatalabelforthespecifiedseriesorchartcurrentlydisplaysitspercentagevalue.ThedefaultvalueisFalse.Thispropertyisavailableonlyforpie,doughnut,andstackedcharts.Read/writeBoolean.

expression.HasPercentage

expressionRequired.AnexpressionthatreturnsaChDataLabelsobject.

RemarksDatalabelcomponentsarealwaysdisplayedinthefollowingorder:[SeriesName][CategoryName][Value][BubbleSize][Percentage].

ExampleThisexampleaddsdatalabelsshowingpercentagevaluetoaseries.NotethatCharts(0)mustrefertoapie,doughnut,orstackedchart.

SubAddPercentabeLabels()DimdlSetdl=ChartSpace1.Charts(0).SeriesCollection(0).DataLabelsCollection.Add'Displaypercentagelabels.dl.HasPercentage=TrueEndSub

HasPlotDetailsProperty

Trueifdetailfieldswillbeplottedwhenthechartdoesnotcontainacategoryfield.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasPlotDetails

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ExampleThisexampleenablesdetailfieldsinChartSpace1tobeplottedwhenthechartdoesnotcontainacategoryfield.

ChartSpace1.HasPlotDetails=True

HasRuntimeSelectionProperty

Returnsorsetstheselectionmodeinthechartsofthespecifiedchartcontrol.WhenthispropertyisTrue,thefirstclickselectstheinnerobject;thesecondclickselectstheouterobject.Forexample,ifthispropertyisTrueandtheuserclicksthethirddatapointinadataseries,onlythatpointisselected.Thesecondtimethattheuserclicksthedatapoint,theentiredataseriesisselected.SettingthispropertytoFalseforcestheentiredataseriestobeselectedwhentheuserclicksthethirddatapointforthefirsttime.Theuserhastoclickthethirddatapointasecondtimeinordertoselectonlythatdatapoint.ThedefaultvalueitTrue.Read/writeBoolean.

expression.HasRuntimeSelection

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

HasSelectionMarksProperty

SetthispropertytoTruetodisplayselectionmarkswhentheuserselectsanitemonachart.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasSelectionMarks

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksInadditiontosettingthispropertytoTrue,youmustalsosettheAllowPropertyToolboxpropertytoTruetoallowtheusertoformatindividualchartelements.

ExampleThisexampleenablestheusertoselectandformatindividualchartelementsinChartspace1.

SubAllow_Formatting()

'AllowtheusertodisplaytheCommandsandOptionsdialogbox.Chartspace1.AllowPropertyToolbox=True

'Displayselectionmarksforchartelements.Chartspace1.HasSelectionMarks=True

EndSub

HasSeriesByRowsProperty

Returnsorsetshowseriesandcategoriesofthechartsinthespecifiedchartcontrolaremappedtotherowsandcolumnsofthedatasource.Bydefault,ifthechartisboundtoarelationaldatasource,thentheseriesofthechartcorrespondtothecolumnsoftheunderlyingPivotTablelist.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasSeriesByRows

expressionRequired.AnexpressionthatreturnsaChartSpacecontrol.

HasSeriesNameProperty

Trueifeverydatalabelforthespecifiedseriesorchartcurrentlydisplaysitsseriesname.ThedefaultvalueisFalse.Thispropertyisavailableonlyforpie,doughnut,andstackedcharts.Read/writeBoolean.

expression.HasSeriesName

expressionRequired.AnexpressionthatreturnsaChDataLabelsobject.

RemarksDatalabelcomponentsarealwaysdisplayedinthefollowingorder:[SeriesName][CategoryName][Value][BubbleSize][Percentage].

ExampleThisexamplecausesthedatalabelsforthespecifiedseriestodisplaytheircategoryandseriesnames.

SubShowLabels()Dimdl

Setdl=ChartSpace1.Charts(0).SeriesCollection(0).DataLabelsCollection(0)

'Displaythecategorynames.dl.HasCategoryName=True'Displaytheseriesnames.dl.HasSeriesName=TrueEndSub

HasSplitProperty

TrueifthescaleforthespecifiedaxishasasplitpointbetweenthevalueofitsSplitMinimumpropertyandthevalueofitsSplitMaximumproperty.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasSplit

expressionRequired.AnexpressionthatreturnsaChScalingobject.

ExampleThisexamplesplitsthevalueaxisofthefirstchartinChartSpace1andsetsthesplitminimumandsplitmaximumvalues.Thevalueaxisissplit,andvaluesbetween1000and5000willnotbedisplayed.

SubSplit_Value_Axis()DimchConstantsDimscValueAxisSetchConstants=ChartSpace1.Constants'Setavariabletothescalingobjectofthevalueaxis.SetscValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).Scaling'Addasplittothevalueaxis.scValueAxis.HasSplit=True'Specifytheminnimumvalueofthesplit.scValueAxis.SplitMinimum=1000'Specifythemaximumvalueforthesplit.scValueAxis.SplitMaximum=5000EndSub

HasTickLabelsProperty

Trueifthespecifiedaxishasalabelateachmajortickmark.ThedefaultvalueisTrue.Read/writeBoolean.

expression.HasTickLabels

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleturnsofftick-marklabelsonthecategoryaxisonthefirstchartinChartSpace1.

SubDisableTickLabels()DimchConstantsSetchConstants=ChartSpace1.Constants'Turnoffthetickmarklabelsonthecategoryaxis.ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory).HasTickLabelsEndSub

HasTitleProperty

Trueifthespecifiedchartoraxishasatitle.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasTitle

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplecausesthetitleofthespecifiedcharttobedisplayedandsetsthetitlefont.

SubSetChartTitle()

'EnablethecharttitleforthefirstchartinChartSpace1.ChartSpace1.Charts(0).HasTitle=True'Setthetitlecaption.ChartSpace1.Charts(0).Title.Caption="MonthlySales"'Setthetitlefont.ChartSpace1.Charts(0).Title.Font.Name="timesnewroman"EndSub

HasUnifiedScalesProperty

Trueifallchartsinthespecifiedchartcontrolusethesamescalingfortheiraxes.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasUnifiedScales

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksThispropertywillreturnarun-timeerrorwhenthechartcontrolcontainsmultiplechartswithincompatibleaxes.Forexample,anerrorwillbereturnedwhenthechartcontrolcontainsanXY(Scatter)chartandaColumnchart.ThispropertycannotbesetbecauseaColumnchartcontainsacategoryaxis,andtheXY(Scatter)chartdoesnot.

WhenyouusetheAddmethodtoaddanewcharttothechartcontrolaftersettingthispropertytoTrue,thenewchart'saxesarenotautomaticallyunifiedwiththeexistingcharts.YoumustsetthispropertytoFalseandthenbacktoTruetounifythenewchart'saxeswiththeexistingcharts.

HasValueProperty

Trueifeverydatalabelforthespecifiedseriesorchartcurrentlydisplaysitsy-axisvalue.ThedefaultvalueisFalse.Read/writeBoolean.

expression.HasValue

expressionRequired.AnexpressionthatreturnsaChDataLabelsobject.

RemarksDatalabelcomponentsarealwaysdisplayedinthefollowingorder:[SeriesName][CategoryName][Value][BubbleSize][Percentage].

SettingthispropertytoTrueonascatterchartorpolarchartcausesbothx-axisvaluesandy-axisvaluestobedisplayed.

ExampleThisexamplesetsthedatalabelsforthespecifiedseriestodisplaytheiry-axisvalues.

ChartSpace1.Charts(0).SeriesCollection(0).DataLabelsCollection(0)HasValue

HeaderBackColorProperty

ReturnsorsetsaVariantindicatingthebackgroundcoloroftheheadingsinthedataareaoraniteminthefilterarea.Read/write.

expression.HeaderBackColor

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).UsetheHeaderFont,HeaderForeColor,andHeaderHAlignmentpropertiesinadditiontothispropertytoformattheheadinginthedataareaoraniteminthefilterareaofaPivotTablelist.

ExampleThisexampleformatstheheaderforthedataareaandthefilterareaofthecurrentviewinPivotTable1.

SubSetHeaderProperties()

DimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'Setthebackgroundcolor.ptView.HeaderBackColor="Gray"

'Settheforegroundcolor.ptView.HeaderForeColor="Blue"

'Setthefont.ptView.HeaderFont="Tahoma"

'Setthealignment.ptView.HeaderHAlignment=ptConstants.plHAlignLeft

EndSub

HeaderFontProperty

ReturnsaPivotFontobjectrepresentingthefontfortheheadingsinthedataareaoraniteminthefilterareaofthespecifiedview.

expression.HeaderFont

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksUsetheHeaderBackColor,HeaderForeColor,andHeaderHAlignmentpropertiestoinadditiontothispropertytoformattheheadinginthedataareaoraniteminthefilterareaofaPivotTablelist.

ExampleThisexampleformatstheheaderforthedataareaandthefilterareaofthecurrentviewinPivotTable1.

SubSetHeaderProperties()

DimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'Setthebackgroundcolor.ptView.HeaderBackColor="Gray"

'Settheforegroundcolor.ptView.HeaderForeColor="Blue"

'Setthefont.ptView.HeaderFont="Tahoma"

'Setthealignment.ptView.HeaderHAlignment=ptConstants.plHAlignLeft

EndSub

HeaderForeColorProperty

ReturnsorsetsaVariantindicatingtheforegroundcoloroftheheadingsinthedataareaoraniteminthefilterareaofthespecifiedview.Read/write.

expression.HeaderForeColor

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).UsetheHeaderBackColor,HeaderFont,andHeaderHAlignmentpropertiesinadditiontothispropertytoformattheheadinginthedataareaoraniteminthefilterareaofaPivotTablelist.

ExampleThisexampleformatstheheaderforthedataareaandthefilterareaofthecurrentviewinPivotTable1.

SubSetHeaderProperties()

DimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'Setthebackgroundcolor.ptView.HeaderBackColor="Gray"

'Settheforegroundcolor.ptView.HeaderForeColor="Blue"

'Setthefont.ptView.HeaderFont="Tahoma"

'Setthealignment.ptView.HeaderHAlignment=ptConstants.plHAlignLeft

EndSub

ShowAll

HeaderHAlignmentProperty

ReturnsorsetsaPivotHAlignmentEnumconstantthatrepresentsthehorizontalalignmentofaheadinginthedataareaoraniteminthefilterareaofthespecifiedview.Read/write.

expression.HeaderHAlignment

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksUsetheHeaderBackColor,HeaderForeColor,andHeaderFontpropertiesinadditiontothispropertytoformattheheadinginthedataareaoraniteminthefilterareaofaPivotTablelist.

ExampleThisexampleformatstheheaderforthedataareaandthefilterareaofthecurrentviewinPivotTable1.

SubSetHeaderProperties()

DimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'Setthebackgroundcolor.ptView.HeaderBackColor="Gray"

'Settheforegroundcolor.ptView.HeaderForeColor="Blue"

'Setthefont.ptView.HeaderFont="Tahoma"

'Setthealignment.ptView.HeaderHAlignment=ptConstants.plHAlignLeft

EndSub

HeaderHeightProperty

ReturnsaLongvaluethatrepresentstheheightoftheheadersforfieldsonthedataaxisandtheitemsinthefilterfieldofthespecifiedview.Read-only.

expression.HeaderHeight

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

HeaderRowRangeProperty

ReturnsaRangeobjectthatrepresentstheheaderrowfromaspecifiedListObjectobject.Read-only.

expression.HeaderRowRange

expressionRequired.AnexpressionthatreturnsaListObjectobject.

Remarks

Ifaheaderrowispresent,aRangeobjectrepresentingtheheaderrowforthespecifiedListObjectobjectisreturned.Ifaheaderrowisn'tpresent,theNothingobjectisreturned.

ExampleTheexamplebelowsavestheheaderrowrangeinformationtoavariable.

DimrngHeaderRowRangeDimobjList SetobjList=Spreadsheet1.ActiveSheet.ListObjects(1)SetrngHeaderRowRange=objList.HeaderRowRange

HeightProperty

Returnsorsetstheheightofthespecifiedobjectinpoints.

Read-onlyDoublefortheWindowobject.

Read-onlyVariantfortheRangeobject.

Read-writeLongforthePivotAxisMember,PivotColumnMember,PivotPageMember,PivotRowMember,andPivotTableobjects.

Read-onlyLongforallotherobjectsintheAppliesTolist.

expression.Height

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksTheAutoFitpropertyofthePivotTablelistissettoFalsewhenthevalueoftheHeightpropertyischanged.

ExampleThisexamplesetstheheightofthePivotTablelistto36points.

PivotTable1.Object.Height=36

HeightRatioProperty

Returnsorsetstheheightratioforthespecifiedchartinrelationtotheotherchartsinthechartworkspace.Thedefaultvalueis100.Read/writeLong.

expression.HeightRatio

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksThispropertysetstheheightofthespecifiedchartrelativetotheheightoftheotherchartsinthechartworkspace.Forthispropertytohaveanyeffect,youmusthavemorethanonechartinthechartworkspace.Whenmorethanonechartisdisplayed,thechartsaredisplayedinagrid(formoreinformation,seetheHelptopicsfortheChartLayoutandChartWrapCountproperties).Initially,theHeightRatioandWidthRatiopropertiesaresetto100forallchartsinthegrid,andallchartsarethesamesize.

Tochangetheheightofchartsinthegrid,adjusttheHeightRatiopropertysettings.Forexample,ifeachchartisdisplayedinthreerows,allthechartshaveaninitialHeightRatiosettingof100.Ifyouwantrow3tobeonlyhalftheavailableheight,setitsHeightRatiosettingto200;theremaininghalfofthechartheightisdividedbetweenrows1and2.BecausetheheightspecifiedbytheHeightRatiopropertyisrelative,youcansetthispropertyforthethreerowsto1,1,2;100,100,200;or20,20,40,allofwhichhavethesameeffect.

Ifthechartworkspacecontainschartsdisplayedinmorethanonerow,thelargestHeightRatiosettingineachrowisusedtosettherelativeheightfortheentirerow.

Thispropertyisusefulforcreatingpriceandvolumestockchartsinwhichthevolumechartishalfthesizeofthepricechart.

HiddenProperty

Trueifthespecifiedrangeiscurrentlyhidden.Therangemustspananentirecolumnorrow.YoucanusetheEntireRowandEntireColumnpropertiestoreturnareferencetoanentireroworcolumn.Read/writeBoolean.

expression.Hidden

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexampleloopsthrougharowthatcontainsdatevalues.Whenthemonthinthecelldoesnotmatchthecurrentmonth,thecolumnishidden.Whenthemonthmatchesthecurrentmonthandthecolumnishidden,thenthecolumnisunhidden.

SubHide_Dates()DimrngLoopRangeDimrngCurrCellDimssConstants

SetssConstants=Spreadsheet1.Constants

'Setrangetoloopthroughtherangeofcontiguous'cellsinrow1startingincolumnA.SetrngLoopRange=Spreadsheet1.ActiveSheet.Range("A1",_Spreadsheet1.ActiveSheet.Range("A1").End(ssConstants.xlToRight))

'Loopthroughthecells.ForEachrngCurrCellInrngLoopRange

'Hidethecolumnifthemonthinthecurrentcelldoes'notmatchthecurrentmonth.IfMonth(rngCurrCell.Value)<>Month(Date)ThenrngCurrCell.EntireColumn.Hidden=True

'Ifthemonthinthecurrentcellmatchesthecurrentmonth'andthecolumnishidden,thenunhidethecolumn.ElseIfrngCurrCell.EntireColumn.HiddenThenrngCurrCell.EntireColumn.Hidden=FalseEndIfNext

EndSub

HoleSizeProperty

Returnsorsetstheholesizeforthespecifieddoughnutchart.Theholesizemustbeavaluefrom0through90(thedefaultvalueis50).Read/writeLong.

expression.HoleSize

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksSettingthispropertytozero(0)changesthedoughnutcharttoapiechart(theTypepropertyfortheChChartobjectreturnschChartTypePieStacked).

ExampleThisexamplesetsholesizeforthespecifiedchart.NotethatCharts(0)mustrefertoadoughnutchart.

ChartSpace1.Charts(0).HoleSize=25

ShowAll

HorizontalAlignmentProperty

ReturnsorsetsaVariantrepresentingthehorizontalalignmentforthespecifiedrange.CanbeanXlHAlignconstant.

expression.HorizontalAlignment

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexampleleft-alignstherangeA1:A5onSheet1.

SubAlignRange()

DimssConstantsSetssConstants=Spreadsheet1.Constants

Worksheets("Sheet1").Range("A1:A5").HorizontalAlignment=ssConstants.xlHAlignLeft

EndSub

HorizontalExtentProperty

YouusetheHorizontalExtentpropertytospecifyordeterminetheextentofthehorizontalviewoftheChScrollViewobject.ReturnsaLong.Read/writeLong.

expression.HorizontalExtent

expressionRequired.AnexpressionthatreturnsaChScrollViewobject.

Remarks

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotareaanditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechartandtheremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.ForinformationonhowthevaluesofthepropertiesoftheChScrollViewobjectrelatetoeachother,seetheChScrollViewobjecttopic.

ExampleThefollowingexampleusestheHorizontalExtentandtheHorizontalExtentMaxpropertiestotoggleachartviewbetweenzoomedandunzoomed(horizontally).Inthisexample,theChartcomponentiscalledChartSpace1.

SubZoomView()DimlngHEM

lngHEM=Chartspace1.Charts(0).ScrollView.HorizontalExtentMax

IfChartspace1.Charts(0).ScrollView.HorizontalExtent=lngHEMThen'Zoomthechart.Chartspace1.Charts(0).ScrollView.HorizontalExtent=(lngHEM/3)Else'Zoomoutonthechart.Chartspace1.Charts(0).ScrollView.HorizontalExtent=lngHEMEndIfEndSub

HorizontalExtentMaxProperty

UsethispropertytospecifyordeterminethemaximumextentofthehorizontalviewoftheChScrollViewobject.ReturnsaLong.Read/writeLong.

expression.HorizontalExtentMax

expressionRequired.AnexpressionthatreturnsaChScrollViewobject.

Remarks

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotareaanditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechartandtheremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.TheHorizontalExtentMaxpropertyrepresentsthetotalheightofachartwhetherthatchartiszoomedornot.ForinformationonhowthevaluesofthepropertiesoftheChScrollViewobjectrelatetoeachother,seetheChScrollViewobjecttopic.

ExampleThefollowingexampleusestheHorizontalExtentandtheHorizontalExtentMaxpropertiestotoggleachartviewbetweenzoomedandunzoomed(horizontally).Inthisexample,theChartcomponentiscalledChartSpace1.

SubZoomView()DimlngHEM

lngHEM=Chartspace1.Charts(0).ScrollView.HorizontalExtentMax

IfChartspace1.Charts(0).ScrollView.HorizontalExtent=lngHEMThen'Zoomthechart.Chartspace1.Charts(0).ScrollView.HorizontalExtent=(lngHEM/3)Else'Zoomoutonthechart.Chartspace1.Charts(0).ScrollView.HorizontalExtent=lngHEMEndIfEndSub

HorizontalPositionProperty

YouusetheHorizontalPositionpropertytospecifyordeterminethecurrenthorizontalviewpositionoftheChScrollViewobject.ReturnsaLong.Read/writeLong.

expression.HorizontalPosition

expressionRequired.AnexpressionthatreturnsaChScrollViewobject.

Remarks

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotareaanditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechartandtheremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.ForinformationonhowthevaluesofthepropertiesoftheChScrollViewobjectrelatetoeachother,seetheChScrollViewobjecttopic.

TheHorizontalPositionpropertyprovidesinformationaboutthehorizontalpositionofachart.TheextremeleftoftheviewableareaoftheChartcomponentis0andtheextremerightoftheviewableareaiswherethevalueoftheHorizontalPositionpropertyequalsthevalueoftheHorizontalExtentMaxproperty(althoughyoucansetthetheHorizontalPositionpropertytovaluesgreaterthanthevalueoftheHorizontalExtentMaxpropertyoreventonegativevalues).AslongasthevalueoftheHorizontalExtentpropertyisgreaterthanthevalueoftheHorizontalExtentMaxproperty,theentirechartwillbevisible.

WhentheHorizontalPositionpropertyequalszero,theextremeleftoftheplotareawillbeattheextremeleftofthescrollviewwindow.WhentheHorizontalPositionequalsHorizontalExtentMax,theplotareaispushedtotheleftsothatrightoftheplotareaisvisibleattheleftofthescrollviewwindow.TheHorizontalPositionpropertycanbeanegativenumber.ForexampleifHorizontalPosition=(-0.25*HorizontalExtentMax)thentheplotareawillbepushedtotherightby25%ofthevirtualwidthoftheplotarea.

ExampleThefollowingexamplechangesthehorizontalandverticalpositionsofthescrollviewoftheChartcomponent(calledChartSpace1inthisexample).

DimlngHorizontalDimlngVertical

lngHorizontal=ChartSpace1.Charts(0)ScrollView.HorizontalPositionlngVertical=ChartSpace1.Charts(0)ScrollView.VerticalPosition

ChartSpace1.Charts(0)ScrollView.SetPositionlngHorizontal+300,lngVertical+200

HTMLContainerProperty

ReturnstheHTMLDIVelementthatcontainsthespecifiedsection.Read-only.

expression.HTMLContainer

expressionRequired.AnexpressionthatreturnsaSectionobject.

HTMLDataProperty

PivotTableandRangeobjects:ReturnsaStringthatrepresentsthespecifiedPivotTablelistorrangeasaproperly-formattedHTMLstring.Read-only.

Spreadsheetobject:ReturnsorsetsaStringthatrepresentsthespreadsheetdataasaproperly-formattedHTMLstring.Read/write.

expression.HTMLData

expressionRequired.AnexpressionthatreturnsoneoftheobjectintheAppliesTolist.

HTMLURLProperty

ReturnsorsetstheURL(Internetaddress)forthespreadsheetHTMLdatafile.Read/writeString.

expression.HTMLURL

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

HwndProperty

ReturnsaLongindicatingthetop-levelwindowhandleofthePivotTablecontrol'swindow.Read-only.

expression.Hwnd

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

HyperlinkProperty

PivotAxisMember,PivotColumnMember,PivotDetailCell,PivotPageMember,andPivotRowMemberobjects:ReturnsaPivotHyperlinkobjectthatrepresentsthehyperlinkforthespecifiedobject.

Rangeobject:ReturnsaHyperlinkobjectthatrepresentsthehyperlinkforthespecifiedrange.

expression.Hyperlink

expressionRequired.AnexpressionthatreturnsoneoftheobjectintheAppliesTolist.

ExampleThisexampleresolvesthehyperlinkincellB15ontheactiveworksheet,downloadsthetargetdocument,andthendisplaysthedocument.

Spreadsheet1.ActiveSheet.Range("b15").Hyperlink.Follow

InclinationProperty

ReturnsorsetsaDoubleindicatingtheinclinationoftheviewofthespecifiedthree-dimensional(3-D)chart.Validvaluesrangefrom-90to90.Read/write.

expression.Inclination

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksSettingthispropertyto90yieldsanoverheadviewofthespecifiedchart.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthensetstheinclinationoftheview.

SubSetGapDepth()

Dimcht3DColumnAsChChart

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3-DColumnchart.cht3DColumn.Type=chChartTypeColumn3D

'Settheinclination.cht3DColumn.Inclination=45

EndSub

ShowAll

IncludeProperty

Returnsorsetstheerrorbarelementsthatwillbeincludedonthespecifiedchart.ThedefaultvalueischErrorBarIncludeBoth.Read/writeChartErrorBarIncludeEnum.

expression.Include

expressionRequired.AnexpressionthatreturnsaChErrorBarsobject.

ExampleThisexampleaddserrorbarstothespecifiedchartandsetstheerrorbarstodisplayonlyplusvalues.

SubFormat_ErrorBars()DimchConstantsDimebErrorBarsSetchConstants=ChartSpace1.Constants'Adderrorbarstothefirstseriesinthefirstchart.SetebErrorBars=ChartSpace1.Charts(0).SeriesCollection(0).ErrorBarsCollection.Add'Includepositivevalues.ebErrorBars.Include=chConstants.chErrorBarIncludePlusValuesEndSub

IncludedMembersProperty

Returnsorsetsthememberstobedisplayedinthespecifiedfield.ThispropertycanbesettoasinglememberoraVariantarrayofmembers.ThememberscanbepassedasoneormorePivotMemberobjects,membernames,oruniquemembernames.Read/write.

expression.IncludedMembers

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksMembersnotlistedwhenyousetthispropertymaystillappearinthePivotTablelistiftheirparentmemberisincluded.Settingthispropertyclearsallprevioussettingsofthispropertyforthespecifiedfield.YoucansetthispropertytoEmpty(IncludedMembers=Empty)ortoazero-lengthVariantarray(IncludedMembers=Array())tocleartheincludedmemberslistforthespecifiedfield.

ExampleThisexamplesetstheincludedandexcludedmembersoftheStoreStateandStoreCityfieldsinPivotTable1.

SubMember_Filtering()

DimfldStoreCityDimfldStoreStateDimptView

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'SetavariabletotheStoreStatefield.SetfldStoreState=ptView.FieldSets("Store").Fields("StoreState")

'SetavariabletotheStoreCityfield.SetfldStoreCity=ptView.FieldSets("Store").Fields("StoreCity")

'ExcludeCaliforniaandWashingtonfromtheStoreStatefield.fldStoreState.ExcludedMembers=Array("CA","WA")

'IncludemembersoftheStoreCityfield.Notethatthecitiesare'instatesthathavebeenexcludedbythepreviousline.Since'StoreStateisaparenttoStoreCity,thentheexcludedstates'aredisplayedinthePivotTable.fldStoreCity.IncludedMembers=Array("LosAngeles","SanDiego",_"Seattle","Spokane")

EndSub

IndexProperty

Returnstheindexnumberofthespecifiedobjectwithinthecollectionofsimilarobjects.Read/writeLongfortheChSeriesobject;read-onlyLongforallotherobjectsintheAppliesTolist.

expression.Index

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksYoucansettheindexnumberofaChSeriesobject.Thespecifiedseriesismovedtothespecifiedposition,andotherseriesarereorderedasnecessary.

TheindexvalueofaListRowobjectcorrespondstoitscurrentpositionintheXMLlist.Followingasort,orafteraddingordeletingarow,agivenrowmayhaveanewindexvaluebasedonitsnewposition.

ExampleThisexamplemovesseries1tothefourthindexpositionofanXYchartcontaining6series.Duringthemove,series2through4arereorderedtoseries1through3.Series0andseries5stayinthesameposition.

ChartSpace1.Charts(0).SeriesCollection(1).Index=4

InsertRowRangeProperty

ReturnstheRangeobjectoftheinsertrow,ifany,fromaspecifiedListObjectobject.Read-only.

expression.InsertRowRange

expressionRequired.AnexpressionthatreturnsaListObjectobject.

Remarks

SomeRangepropertiesandmethodsarenotsupported.ThepropertiesnotsupportedareLocked,MergeAreaandMergeCells.ThemethodsnotsupportedareDelete,Insert,Merge,andUnMerge.Iftheinsertrowisnotcurrentlyvisible,theNothingobjectwillbereturned.

YoucanreferenceanycellintheinsertrowusingtheInsertRowRangeproperty.PropertiesoftheborderoftheRangereturnedbytheInsertRowRangepropertyarenotsavedafteranewrowisaddedtoanXMLlist.

ExampleTheexamplebelowgetstheinsertrowrangeinformationanddisplaysit.

DimrngInsertRowDimobjListSetobjList=Spreadsheet1.Worksheets(1).ListObjects(1)

'Savetheinsertrangeinformationtoavariable.SetrngInsertRow=objList.InsertRowRange

MsgBox("Theinsertrowrangeis:"&Chr(10)&rngInsertRow.Address)

ShowAll

InteriorProperty

InteriorpropertyasitappliestotheChartSpace,ChChart,ChChartDraw,ChDataLabel,ChDataLabels,ChLegend,ChPlotArea,ChPoint,ChSegmentBoundary,ChSeries,ChSurface,andChTitleobjects.

InteriorpropertyasitappliestotheRangeandTitleBarobjects.

ExampleThisexamplesetstheinteriorcolorforthespecifiedseries.

ChartSpace1.Charts(0).SeriesCollection(0).Interior.Color="red"

InternalPivotTableProperty

ReturnsaPivotTableobjectthatisusedinternallybythechartcontroltobindtoanexternaldatasource.

expression.InternalPivotTable

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

InternationalProperty

Returnsinformationaboutthecurrentcountry/regionandinternationalsettings.Read-onlyVariant.

expression.International(Index)

expressionRequired.AnexpressionthatreturnsaSpreadsheetoraChartSpaceobject.

IndexRequiredLong.Thesettingtobereturned.CanbeoneoftheXlApplicationInternationalconstantslistedinthefollowingtable.

Index Type MeaningxlCountryCode Long Country/regionversionofthe

MicrosoftOfficeWebComponents.

xlCountrySetting Long CurrentlocalesettinginControlPanel.

xlDecimalSeparator String Decimalseparator.xlThousandsSeparator String Zeroorthousandsseparator.xlListSeparator String Listseparator.xlUpperCaseRowLetter String Uppercaserowletter(forR1C1-

stylereferences).xlUpperCaseColumnLetter String Uppercasecolumnletter.xlLowerCaseRowLetter String Lowercaserowletter.xlLowerCaseColumnLetter String Lowercasecolumnletter.xlLeftBracket String Characterusedinsteadoftheleft

bracket([)inR1C1-stylerelativereferences.

xlRightBracket String Characterusedinsteadoftherightbracket(])inR1C1-stylereferences.

xlLeftBrace String Characterusedinsteadoftheleftbrace({)inarrayliterals.

xlRightBrace String Characterusedinsteadofthe

rightbrace(})inarrayliterals.xlColumnSeparator String Characterusedtoseparate

columnsinarrayliterals.xlRowSeparator String Characterusedtoseparaterows

inarrayliterals.xlAlternateArraySeparator String Alternatearrayitemseparatorto

beusedifthecurrentarrayseparatoristhesameasthedecimalseparator.

xlDateSeparator String Dateseparator(/).xlTimeSeparator String Timeseparator(:).xlYearCode String Yearsymbolinnumberformats

(y).xlMonthCode String Monthsymbol(m).xlDayCode String Daysymbol(d).xlHourCode String Hoursymbol(h).xlMinuteCode String Minutesymbol(m).xlSecondCode String Secondsymbol(s).xlCurrencyCode String Currencysymbol.xlGeneralFormatName String NameoftheGeneralnumber

format.xlCurrencyDigits Long Numberofdecimaldigitstobe

usedincurrencyformats.xlCurrencyNegative Long Currencyformatfornegative

currencyvalues:0=(symbolx)or(xsymbol)1=-symbolxor-xsymbol2=symbol-xorx-symbol3=symbolx-orxsymbol-wheresymbolisthecurrencysymbolofthecountryorregion.NotethatthepositionofthecurrencysymbolisdeterminedbyxlCurrencyBefore.

xlNoncurrencyDigits Long Numberofdecimaldigitstobe

usedinnon-currencyformats.xlMonthNameChars Long Alwaysreturnsthreecharacters

forbackwardcompatibility.AbbreviatedmonthnamesarereadfromMicrosoftWindowsandcanbeanylength.

xlWeekdayNameChars Long Alwaysreturnsthreecharactersforbackwardcompatibility.AbbreviatedweekdaynamesarereadfromMicrosoftWindowsandcanbeanylength.

xlDateOrder Long Orderofdateelements:0=month-day-year1=day-month-year2=year-month-day

xl24HourClock Boolean Trueifyou’reusing24-hourtime;Falseifyou’reusing12-hourtime.

xlNonEnglishFunctions Boolean Trueifyou’renotdisplayingfunctionsinEnglish.

xlMetric Boolean Trueifyou’reusingthemetricsystem;Falseifyou’reusingtheEnglishmeasurementsystem.

xlCurrencySpaceBefore Boolean Trueifaspaceisaddedbeforethecurrencysymbol.

xlCurrencyBefore Boolean Trueifthecurrencysymbolprecedesthecurrencyvalues;Falseifitfollowsthem.

xlCurrencyMinusSign Boolean Trueifyou’reusingaminussignfornegativenumbers;Falseifyou’reusingparentheses.

xlCurrencyTrailingZeros Boolean Trueiftrailingzerosaredisplayedforzerocurrencyvalues.

xlCurrencyLeadingZeros Boolean Trueifleadingzerosaredisplayedforzerocurrencyvalues.

xlMonthLeadingZero Boolean Trueifaleadingzeroisdisplayedinmonths(whenmonthsaredisplayedasnumbers).

xlDayLeadingZero Boolean Trueifaleadingzeroisdisplayedindays.

xl4DigitYears Boolean Trueifyou’reusingfour-digityears;Falseifyou’reusingtwo-digityears.

xlMDY Boolean Trueifthedateorderismonth-day-yearfordatesdisplayedinthelongform;Falseifthedateorderisday-month-year.

xlTimeLeadingZero Boolean Trueifaleadingzeroisdisplayedintimes.

RemarksSymbols,separators,andcurrencyformatsshownintheprecedingtablemaydifferfromthoseusedinyourlanguageorgeographiclocationandmaynotbeavailabletoyou,dependingonthelanguagesupport(U.S.English,forexample)thatyou’veselectedorinstalled.

IsConsistentProperty

ReturnsaBooleanthatindicateswhetherthesourcedatasetisconsistentwiththespecifiedPivotDataobject.Read-only.

expression.IsConsistent

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

RemarksThispropertyreturnsFalsewhenchangestothedatasethavebeencommitted,butthetotalshavenotbeenupdated.Whenthisoccurs,youcanusetheRefreshmethodofthePivotTableobjecttoupdatethetotals.

IsDataBoundProperty

ReturnsorsetsaBooleanthatdetermineswhetherthespecifiedworksheetisboundtoanoutsidedatasource.Read/write.

expression.IsDataBound

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

IsDirtyProperty

ReturnsorsetsaBooleanthatindicateswhetherthePivotTablelisthaschangedsincethelasttimeitwassaved.Read/write.

expression.IsDirty

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

IsDisplayingEquationProperty

Trueiftheequationforthetrendlineforthespecifiedseriesisdisplayedonthechart(inthesamedatalabelastheR-squaredvalue).ThedefaultvalueisTrue.Read/writeBoolean.

expression.IsDisplayingEquation

expressionRequired.AnexpressionthatreturnsaChTrendlineobject.

ExampleThisexampleaddsatrendlinetothespecifiedseries.Onlythetrendlineequationisdisplayed.

SubAddTrendLine()Dimtrndline'AddatrendlinetothefirstseriesinthefirstchartinChartSpace1.Settrndline=ChartSpace1.Charts(0).SeriesCollection(0).Trendlines.Add'Setthefontofthetrendlinetobold.trndline.DataLabel.Font.Bold=True'DonotdisplaytheR-Squaredvaluewiththetrendline.trndline.IsDisplayingRSquared=False'Displaytheequationforthetrendline.trndline.IsDisplayingEquation=TrueEndSub

IsDisplayingRSquaredProperty

TrueiftheR-squaredvalueforthetrendlineforthespecifiedseriesisdisplayedonthechart(inthesamedatalabelastheequation).SettingthispropertytoTrueautomaticallyturnsondatalabels.ThedefaultvalueisTrue.Read/writeBoolean.

expression.IsDisplayingRSquared

expressionRequired.AnexpressionthatreturnsaChTrendlineobject.

ExampleThisexampleaddsatrendlinetothespecifiedseries.Onlythetrendlineequationisdisplayed.

SubAddTrendLine()Dimtrndline'AddatrendlinetothefirstseriesinthefirstchartinChartSpace1.Settrndline=ChartSpace1.Charts(0).SeriesCollection(0).Trendlines.Add'Setthefontofthetrendlinetobold.trndline.DataLabel.Font.Bold=True'DonotdisplaytheR-Squaredvaluewiththetrendline.trndline.IsDisplayingRSquared=False'Displaytheequationforthetrendline.trndline.IsDisplayingEquation=TrueEndSub

IsExpandedProperty

Trueifthespecifiedsectionisexpanded.Read-onlyBoolean.

expression.IsExpanded

expressionRequired.AnexpressionthatreturnsaSectionobject.

IsFilteredProperty

Trueifthecurrentfilterisapplied.ThedefaultvalueisTrue.Read/writeBoolean.

expression.IsFiltered

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

IsFilterOnProperty

Trueifthedataaccesspagefilterisapplied.Read/writeBoolean.

expression.IsFilterOn

expressionRequired.AnexpressionthatreturnsaDataPageobject.

ShowAll

IsHyperlinkProperty

IsHyperlinkpropertyasitappliestothePivotFieldobject.

IsHyperlinkpropertyasitappliestotheSchemaFieldandSchemaParameterobjects.

ExampleAsitappliestothePivotFieldobject.

IsIncludedProperty

Trueifthefieldisincludedandactiveinthespecifiedfieldset.Read/writeBoolean.

expression.IsIncluded

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksInactivefieldsarenotvisibleinthePivotTablelist.AfieldsetmusthaveatleastonefieldforwhichtheIsIncludedpropertyissettoTrue.AttemptingtosetthispropertytoFalsefortheonlyfieldwhereitissettoTruegeneratesarun-timeerror.Thispropertyisignoredwhenthefieldsetisusedonthefilteraxis.Iftheuserhidesthelastfieldintheuserinterface,thefieldsetisremovedfromtheaxis.

IsTotalProperty

Trueifthespecifiedmemberisusedtodisplayasubtotal.Read-onlyBoolean.

expression.IsTotal

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

IsValidProperty

ReturnsaBooleanthatindicatedwhetherthespecifiedmemberisavalidmemberwithinthespecifiedcontext.Read-only.

expression.IsValid

expressionRequired.AnexpressionthatreturnsaPivotMemberobject.

ExampleThisexampleattemptstofindaspecificwarehouseintheWarehousefieldset.Theuserisalertedifthespecifiedwarehouseisnotfound.

SubFindWarehouse()

DimptViewDimptConstantsDimfsWarehouseDimpmFound

SetptConstants=PivotTable1.Constants

'Setavariabletotheactiveview.SetptView=PivotTable1.ActiveView

'SetavariabletotheWarehousefieldset.SetfsWarehouse=ptView.FieldSets("Warehouse")

'SetavariabletotheresultsoftheFindMemberproperty.SetpmFound=fsWarehouse.FindMember("QualityDistribution,Inc.",ptConstants.plFindFormatPathName)

'Checktoseeifthememberwasfound.IfpmFound.IsValid=FalseThen

'Alerttheuserifthememberwasnotfound.MsgBox"Thespecifiedmemberdoesnotexist."

EndIf

EndSub

ItalicProperty

Trueifthefontstyleisitalic.Read/writeBooleanfortheChFontandPivotFontobjects;read/writeVariantfortheFontobject(returnsNullifsomeportionsofthetextareitalicandsomearenot).UsetheIsNullfunctiontodeterminewhetherthereturnvalueisNull.

expression.Italic

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsthefonttoitalicforthecontentsofcolumnB.

Spreadsheet1.Columns(2).Font.Italic=True

ShowAll

ItemProperty

ItempropertyasitappliestotheBordersobject.

ItempropertyasitappliestotheChCategoryLabelsobject.

ItempropertyasitappliestothePivotMemberPropertiesandPivotResultMemberPropertiesobjects.

ItempropertyasitappliestotheRangeobject.

ItempropertyasitappliestotheXmlDataBindingscollection.

ItempropertyasitappliestotheXmlMapsobject.

ItempropertyasitappliestotheListObjectscollection.

ItempropertyasitappliestoallotherobjectsintheAppliesTolist.

ItemCountProperty

ReturnsaLongspecifyingthenumberofcategorylabelsforthespecifiedchartaxis.Read-only.

expression.ItemCount(Level)

expressionRequired.AnexpressionthatreturnsaChCategoryLabelsobject.

LevelOptionalLong.Thelevelofcategorylabelstoreturnthecountof.Bydefault,thecountoftheinnermostleveloflabelsisreturned.

ShowAll

JoinTypeProperty

Returnsorsetsthewayaquerywillbeformed.Read/writeDscJoinTypeEnum.

expression.JoinType

expressionRequired.AnexpressionthatreturnsaPageRelationshipobject.

RemarksYoucanusethispropertyonlyifthePageRelationshipobject'sTypepropertyissettodscLookup.

ShowAll

LabelProperty

LabelpropertyasitappliestothePivotAxis,PivotDataAxis,PivotFilterAxis,PivotGroupAxis,andPivotViewobjects.

LabelpropertyasitappliestothePivotData,PivotResultAxis,PivotResultColumnAxis,PivotResultDataAxis,PivotResultFilterAxis,PivotResultGroupAxis,PivotResultPageAxis,andPivotResultRowAxisobjects.

ShowAll

LanguageIDProperty

ReturnsaLongrepresentingthelocaleidentifier(LCID)fortheinstalllanguage,theuserinterfacelanguage,ortheHelplanguage.Read-only.

expression.LanguageID(id)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

idRequiredMsoAppLanguageID.

ShowAll

LanguagePreferredForEditingProperty

ReturnsTrueifthevalueforthemsoLanguageIDconstanthasbeenidentifiedintheregistryasapreferredlanguageforediting.Read-onlyBoolean.

expression.LanguagePreferredForEditing(lid)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

lidRequiredMsoLanguageID.Thelanguagetocheckforintheregistry.

RemarksYoumusttestallvalidmsoLanguageIDvaluestoenumeratethesetofpreferredlanguages.

ExampleThefollowingexampletestswhethertheU.S.Englishlanguageisregisteredasapreferrededitinglanguage.

IfSpreadsheet1.LanguageSettings._LanguagePreferredForEditing(msoLanguageIDEnglishUS)Then

MsgBox"U.S.Englishisoneofthechoseneditinglanguages."

EndIf

ShowAll

LeftProperty

LeftpropertyasitappliestotheChartSpace,ChCategoryLabel,ChChartField,ChDataLabel,ChDataLabels,ChErrorBars,ChLegendEntry,ChPoint,ChSeries,ChTrendline,PivotAggregate,PivotAxisMember,PivotColumnMember,PivotDetailCell,PivotPageMember,PivotResultAxis,PivotResultColumnAxis,PivotResultDataAxis,PivotResultFilterAxis,PivotResultGroupAxis,PivotResultLabel,PivotResultPageAxis,PivotResultRowAxis,PivotRowMember,andPivotTableobjects.

LeftpropertyasitappliestotheChScrollViewobject.

LeftpropertyasitappliestothePivotDataobject.

LeftpropertyasitappliestotheRangeobject.

LeftpropertyasitappliestotheWindowobject.

ExampleThisexamplescrollstotheleftthroughthespreadsheetwindowtodisplaycellF1ifthiscelliscurrentlytotheleftofthevisiblerange.

SubScrollSheet

DimrngScroll

SetrngScroll=Spreadsheet1.Range("f1")

IfrngScroll.Left<0ThenSpreadsheet1.ActiveSheet.ScrollrngScroll

EndSub

Left2Property

ReturnsaLongvaluethatrepresentsthedistancefromtheleftsideofthePivotTablelisttothedataarea.Thispropertyalwaysreturns1.Read-only.

expression.Left2

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

LeftOffsetProperty

ReturnsorsetsaLongvaluethatrepresentsthenumberofpixelstoscrollthedataareatotheleft.Read/write.

expression.LeftOffset

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

RemarksUsetheTopOffsettoscrollthedataareadown.

ExampleThisexamplescrollsthedataareaofPivotTable1down45pixelsandleft45pixels.

SubScrollDataArea()

DimptData

SetptData=PivotTable1.ActiveData

'Scroll45pixelsdown.ptData.TopOffset=45

'Scrollthedataareatotheleft.ptData.LeftOffset=45

EndSub

LegendProperty

ReturnsaChLegendobjectthatrepresentsthelegendforthespecifiedchart.

expression.Legend

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexamplecausesthespecifiedcharttodisplayitslegendandthensetsthelegendfont.

SubAddLegend()

'EnablethelegendforthefirstchartinChartspace1.ChartSpace1.Charts(0).HasLegend=True

'Setthefontforthelegend.ChartSpace1.Charts(0).Legend.Font.Name="TimesNewRoman"

EndSub

LegendEntriesProperty

ReturnsaChLegendEntriescollectionforthespecifiedlegend.

expression.LegendEntries

expressionRequired.AnexpressionthatreturnsaChLegendobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ExampleThisexamplehidesthespecifiedlegendentry.

ChartSpace1.Charts(0).Legend.LegendEntries(1).Visible=False

LengthProperty

Returnsorsetsthemaximumfieldorparameterlength.Read/writeLong.

expression.Length

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

LevelCountProperty

ReturnsaLongindicatingthenumberoflevelsinahierarchicalchartaxis.Read-only.

expression.LevelCount

expressionRequired.AnexpressionthatreturnsaChCategoryLabelsobject.

LightNormalProperty

ReturnsorsetsaDoublespecifyingtheamountthatthelightisbentfrom90degreesinathree-dimensional(3-D)chart.Validvaluesrangefrom0to1.Read/write.

expression.LightNormal

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksSettingthispropertyto0resultsinaflatlookforyourchart,whilesettingthispropertyto0.5yieldsamorethree-dimensionallook.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthensetstheLightNormalpropertyofthechart.

SubSetGapDepth()

Dimcht3DColumnAsChChart

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3-DColumnchart.cht3DColumn.Type=chChartTypeColumn3D

cht3DColumn.LightNormal=0.8

EndSub

LineProperty

ReturnsaChLineobjectthatyoucanusetochangetheappearanceofthespecifiedchartelement.

expression.Line

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksWhenusedwithotherproperties,theLinepropertycanformataxes,trendlines,linesonlineorstockcharts,errorbars,andgridlines.

ExampleThisexamplesetsthelinecolorforthespecifiedseries.

ChartSpace1.Charts(0).SeriesCollection(0).Line.Color="red"

LineStyleProperty

Returnsorsetstheborderlinestyleforthespecifiedrange.CanbeoneoftheLineStyleEnumconstants;returnsNullifthebordersdonotallhavethesamestyle.UsetheIsNullfunctiontodeterminewhetherthereturnvalueisNull.Read/writeVariant.

expression.LineStyle

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksYoucannotsetthispropertyforaChBorderobjectthatrepresentsachartelement.

ExampleThisexampleputsagreendash-dotborderaroundeachcellintherangeA1:E5.

SubSetBorder()

DimrngCurrentDimssConstants

SetssConstants=Spreadsheet1.Constants

SetrngCurrent=Spreadsheet1.Range("a1:e5")

rngCurrent.Borders.LineStyle=ssConstants.ssConstants.xlDashDot

rngCurrent.Borders.Color="Green"

EndSub

ListBoundFieldProperty

Returnsorsetsthefieldthatisboundinthespecifiedlistorcombobox(asopposedtothefieldthatisdisplayed).Appliesonlytolistboxesandcomboboxes.Read/writeString.

expression.ListBoundField

expressionRequired.AnexpressionthatreturnsanElementExtensionobject.

RemarksUsetheListDisplayFieldpropertytoreturnorsetthedisplayedfield.

ThispropertyisusedwiththeListRowSourceandListDisplayFieldpropertiestocontrolhowdataisdisplayedinalistboxorcombobox.Forexample,consideralistboxthatdisplaysproductnamesinasectioncalledOrderDetails.TherecordsetbehindtheOrderDetailssectionincludesafieldnamedProductIDthatrepresentstheproductforagivenOrderDetailrecord.ButinsteadofdisplayingProductIDinatextbox,thepageauthorwantstodisplayproductnamesinadropdownlistbox.ThelistboxcanbefilledwitharecordsetdefinitionnamedProductswhichcontainsfieldscalledProdIDandProductNamefromtheProducttable.Thepropertiesofthislistboxelementwouldbesetasshowninthefollowingtable.

Property ValueListRowSource ProductsListBoundField ProdIDListDisplayField ProductNameControlSource ProductID

ListDisplayFieldProperty

Returnsorsetsthefieldthatisdisplayedinthelistorcombobox(asopposedtothefieldthatisbound).Therecanbeonlyonedisplayedfield.Thispropertyappliesonlytolistboxesandcomboboxes.Read/writeString.

expression.ListDisplayField

expressionRequired.AnexpressionthatreturnsanElementExtensionobject.

RemarksUsetheListBoundFieldpropertytoreturnorsettheboundfield.

ThispropertyisusedwiththeListRowSourceandListBoundFieldpropertiestocontrolhowdataisdisplayedinalistboxorcombobox.Forexample,consideralistboxthatdisplaysproductnamesinasectioncalledOrderDetails.TherecordsetbehindtheOrderDetailssectionincludesafieldnamedProductIDthatrepresentstheproductforagivenOrderDetailrecord.ButinsteadofdisplayingProductIDinatextbox,thepageauthorwantstodisplayproductnamesinadropdownlistbox.ThelistboxcanbefilledwitharecordsetdefinitionnamedProductswhichcontainsfieldscalledProdIDandProductNamefromtheProducttable.Thepropertiesofthislistboxelementwouldbesetasshowninthefollowingtable.

Property ValueListRowSource ProductsListBoundField ProdIDListDisplayField ProductNameControlSource ProductID

ShowAll

ListObjectProperty

AsitappliestotheRangeobject.

AsitappliestotheWorkbookobject.

ExampleAsitappliestotheRangeobject.AsitappliestotheWorkbookobject.

ListObjectsProperty

ReturnstheListObjectscollectionfortheWorksheetobject.Read-only.

expression.ListObjects

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

Remarks

YouusetheListObjectspropertytoreturntheListObjectscollectionforaspecifiedWorksheetobject.ThenyouiteratethroughtheListObjectscollectiontogeteachListObjectobjectonthatworksheet.

ExampleThefollowingexampleworkswitheachListObjectsobjectrelatedtoaSpreadsheetcomponent(namedSpreadsheet1).ThecodeusestheListObjectspropertyofthesecondWorksheetobjecttoreturntheListObjectscollection.ItthengetsthenameoftheListObjectobject.ThisnamecorrespondstothevalueoftheIDattributeofanMapInfo/Map/EntryintheschemamapsyntaxintheXMLSpreadsheetfile.

TheXMLfragmentwherethedetailsappearintheXMLSpreadsheetfilelookssomethinglikethefollowingfragment.Inthisexample,thenameoftheListObjectobjectisCust_MapId:

<x2:MapInfoxmlns:x2="http://schemas.microsoft.com/office/excel/2003/xml"><x2:Mapx2:ID="Cust_MapId"><x2:Entryx2:ID="example_id"x2:Type="table">...</x2:Entry></x2:Map></x2:MapInfo>

DimobjListsDimobjListDimstrName

SetobjLists=Spreadsheet1.Worksheets(2).ListObjects

ForEachobjListinobjLists'SavetheListObjectnametoavariable.strName=objList.Name

'Workwiththatparticularlistobjecthere.

Next

ThisexamplesetsthelineweightoftheborderforthespecifiedListObjectintheSpreadsheetcomponent(namedSpreadsheet1).

DimssConstants

SetssConstants=Spreadsheet1.Constants'Setavariabletotherangetoaddthebordersto.rngList=Spreadsheet1.ActiveSheet.ListObjects(1).Range'Setwholerangeborderweight.rngList.Weight=ssConstants.owcLineWeightMedium

ListRowsProperty

ReturnsaListRowscollectionthatrepresentsalltherowsofdataintheListObjectobject.Itdoesnotincludetheheaderorinsertrows.Read-only.

expression.ListRows

expressionRequired.AnexpressionthatreturnsaListObjectobject.

Remarks

YouusetheListRowspropertytoreturntheListRowscollectionforaspecifiedListObjectobject.ThenyouiteratethroughtheListRowscollectiontogeteachListRowobjectonthatworksheet.

ExampleThefollowingexampleshowsyouhowtoretrievelistrowinformationforaspecificlistrow,inthiscase,theeighthrow.

DimobjListsDimobjLRowsDimobjLRow

SetobjLists=Spreadsheet1.ActiveSheet.ListObjectsSetobjLRows=objLists.Item(1).ListRows'Savethelistrowinformationoflistrownumber8toavariable.SetobjRow=objLRows.Item(8)

'Workwiththelistrowinformationhere.

ListRowSourceProperty

Specifiesthedatasourceforalistboxorcombobox.Thispropertyappliesonlytolistboxesandcomboboxes,anditmustbesetbeforetheListBoundFieldorListDisplayFieldpropertyisset.Read/writeString.

expression.ListRowSource

expressionRequired.AnexpressionthatreturnsanElementExtensionobject.

RemarksThispropertyisusedwiththeListBoundFieldandListDisplayFieldpropertiestocontrolhowdataisdisplayedinalistboxorcombobox.Forexample,consideralistboxthatdisplaysproductnamesinasectioncalledOrderDetails.TherecordsetbehindtheOrderDetailssectionincludesafieldnamedProductIDthatrepresentstheproductforagivenOrderDetailrecord.ButinsteadofdisplayingProductIDinatextbox,thepageauthorwantstodisplayproductnamesinadropdownlistbox.ThelistboxcanbefilledwitharecordsetdefinitionnamedProductswhichcontainsfieldscalledProdIDandProductNamefromtheProducttable.Thepropertiesofthislistboxelementwouldbesetasshowninthefollowingtable.

Property ValueListRowSource ProductsListBoundField ProdIDListDisplayField ProductNameControlSource ProductID

LoadModeProperty

ReturnsanenumerationconstantthatrepresentsthenumericequivalentoftheLoadModeattributevalueofthe<Binding>elementforaparticulardatabinding.Read-onlyBindingLoadMode.

expression.LoadMode

expressionRequired.AnexpressionthatreturnsanXMLDataBindingobject.

Remarks

AnXMLDataBindingobjectcanbeabindingtoanXMLfile,anarbitrarySOAPservice,anotherWebpart(fortheSpreadsheetWebPart),oradataretrievalservice.TheLoadModepropertydescribesthebindingbehaviorforloading.ThepossibleLoadModepropertysettingsandtheirnumericequivalentareshownbelow.Ifnotprovided,adefaultof"normal"isassumed:

BindingLoadMode DescriptionNormal(0) Foraquerybinding,bindingoccursatfirstload,

whentheuserclickstheRefreshAlltoolbarbutton,RefreshcommandonthetoolstripintheSpreadsheetWebPart,ortheRefreshDatacommandonthecontextmenuintheSpreadsheetcomponent.Bindingcanbedoneprogrammaticallyaswell.

Foranupdatebinding,bindingoccurseverytimetheuserclickstheUpdateDatacommandonthetoolstripintheSpreadsheetWebPart,orwhenusingtheSaveDatacommandonthecontextmenu.Bindingcanalsooccurprogrammatically

OM(1) Foraquerybinding,bindingdoesnotoccuratfirstload,whentheuserclickstheRefreshAlltoolbarbutton,RefreshcommandonthetoolstripintheSpreadsheetWebPart,ortheRefreshDatacommandonthecontextmenuintheSpreadsheetcomponent.BindingalsodoesnotoccurwhentheRefreshmethodiscalledontheSpreadsheetobject.BindingonlyoccurswhentheRefreshmethodoftheXmlDataBindingobjectiscalled.

Foranupdatebinding,bindingdoesnotoccuratfirstload,whentheuserclickstheUpdateDatacommandonthetoolstripintheSpreadsheetWeb

Part,orwhenusingtheSaveDatacommandonthecontextmenu.BindingonlyoccurswhentheUpdatemethodoftheXmlDataBindingobjectiscalled.

Delay(2) Foraquerybinding,whentheuserclickstheRefreshAlltoolbarbutton,theRefreshcommandonthetoolstripintheSpreadsheetWebPart,ortheRefreshDatacommandonthecontextmenu.Bindingcanbedoneprogrammaticallyaswell.

Foranupdatebinding,thebehavioristhesameasdescribedfortheNormalenumeration.

ShowAll

LocationProperty

Returnsorsetsthelocationofthecalculatedfieldevaluation.Read/writeDscLocationEnum.

expression.Location

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksThispropertycontrolswherecalculatedfieldsareevaluated.WhenthispropertyissettodscServer,theexpressionisincludedintheSQLstringsenttothedatabaseandmustbeinthecorrectSQLsyntaxforthedatabase.WhenthispropertyissettodscClient,theexpressionisevaluatedontheclientcomputerusingVisualBasicforApplicationsexpressions.

LockedProperty

Trueifallcellsinthespecifiedrangearelocked,Falseifnoneofthecellsarelocked,andNullifsomecellsarelockedandsomearenot.ThedefaultvalueisTrue.UsetheIsNullfunctiontodeterminewhetherthereturnvalueisNull.Read/writeVariant.

expression.Locked

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplelocksonlythecellsincolumnBontheactivesheetinSpreadsheet1andthenprotectstheworksheet.

SubLockColumnB()DimshtCurrentSetshtCurrent=Spreadsheet1.ActiveSheet'Clearthelockedattributeforallcellsontheactivesheet.shtCurrent.Cells.Locked=False'LockallofthecellsinColumnB.shtCurrent.Columns(2).Locked=True'Enableprotectionontheactivesheet.shtCurrent.Protection.Enabled=TrueEndSub

LogBaseProperty

Setsthebaseofthelogarithmwhenyouareusinglogscales.Attemptingtosetthispropertytoavaluelessthanorequaltozero(0)causesanerror.Read/writeDouble.

expression.LogBase

expressionRequired.AnexpressionthatreturnsaChScalingobject.

ExampleThisexamplecausesthespecifiedaxistouseabase2logarithmicscale.

SubSetScaling()

DimchConstantsDimscValueAxisScaling

SetchConstants=ChartSpace1.Constants

'Setavariabletothescalingobjectofthevalueaxis.SetscValueAxisScaling=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).Scaling

'Setthescalingtype.scValueAxisScaling.Type=chConstants.chScaleTypeLogarithmic

'Setthebasevalue.scValueAxisScaling.LogBase=2

EndSub

LookupRelationshipsProperty

ReturnstheLookupRelationshipscollectionforthespecifiedpagerowsource.Read-only.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

expression.LookupRelationships

expressionRequired.AnexpressionthatreturnsaPageRowsourceobject.

RemarksLookupRelationshipobjectsrefertorowsourcesthathaveaone-to-manyrelationshipwiththespecifiedpagerowsource.FieldsfromtheserowsourcescanappearinthesamesectionorPivotTablelistasfieldsfromthespecifiedrowsource.

LookupSchemaRelationshipsProperty

ReturnstheLookupSchemaRelationshipscollectionforthespecifiedschemarowsource.Read-only.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

expression.LookupSchemaRelationships

expressionRequired.AnexpressionthatreturnsaSchemaRowSourceobject.

MajorGridlinesProperty

ReturnsaChGridlinesobjectthatrepresentsthemajorgridlinesforthespecifiedaxis.Notethatyoucanusegridlinesonanyaxis.Read-only.

expression.MajorGridlines

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetsthecolorandlineweightforthegridlinesonthevalueaxisofthefirstchartinChartSpace1.

SubFormat_Gridlines()DimchConstantsDimglMajorGridlinesDimglMinorGridlines

SetchConstants=ChartSpace1.Constants

'Setavariabletothemajorgridlinesonthevalueaxis.SetglMajorGridlines=ChartSpace1.Charts(0).Axes(_chConstants.chAxisPositionValue).MajorGridlines

'Setavariabletotheminorgridlinesonthevalueaxis.SetglMinorGridlines=ChartSpace1.Charts(0).Axes(_chConstants.chAxisPositionValue).MinorGridlines

'Setthecolorandweightofthemajorgridlines.glMajorGridlines.Line.Color="white"glMajorGridlines.Line.Weight=5

'Setthecolorandweightoftheminorgridlines.glMinorGridlines.Line.Color="yellow"glMajorGridlines.Line.Weight=2EndSub

ShowAll

MajorTickMarksProperty

Returnsorsetsthemajortick-marktypeforthespecifiedaxis.Read/writeChartTickMarkEnum.

expression.MajorTickMarks

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleturnsoffmajortickmarksonthespecifiedaxis.

SubDisableMajorTickMarks()DimchConstants

SetchConstants=ChartSpace1.Constants

ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionLeft).MajorTickMarks=chConstants.chTickMarkNoneEndSub

MajorUnitProperty

Returnsorsetsthemajorunitforthespecifiedaxis.Usethispropertyonlywithavalueaxis.Read/writeDouble.

expression.MajorUnit

expressionRequired.AnexpressionthatreturnsaChAxisobject.

RemarksSettingthispropertycausestheHasAutoMajorUnitpropertytobesettoFalse.

ExampleThisexamplesetsthemajorandminorunitforthevalueaxis.

SubSetValueAxis()DimchConstantsDimaxValueAxis

SetchConstants=ChartSpace1.Constants

SetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)

axValueAxis.MajorUnit=7axValueAxis.MinorUnit=2.5EndSub

MajorVersionProperty

ReturnsthemajorversionoftheMicrosoftOfficeWebComponentsobjectlibrary.Read-onlyLong.

expression.MajorVersion

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampledisplaysthemajorversionofSpreadsheet1.

MsgboxSpreadsheet1.MajorVersion

ShowAll

ManySideProperty

ManySidepropertyasitappliestothePageRelatedFieldobject.

ManySidepropertyasitappliestothePageRelationshipobject.

ManySidepropertyasitappliestotheSchemaRelatedFieldandSchemaRelationshipobjects.

MapDataProperty

YouusetheMapDatapropertytospecifyordeterminetheschemamapforanXmlMapobject.Read/writeString.

expression.MapData

expressionRequired.AnexpressionthatreturnsanXmlMapobject.

Remarks

TheXmlMapobjectiscreatedwhenanXMLSpreadsheetfilecontainingbindingandmappinginformationisloadedintotheSpreadsheetcomponentbysettingtheXMLURLorXMLDataproperty.YoucancreateanXMLSpreadsheetfilebyimportingandmappingdatatoaworksheetusingMicrosoftOfficeExcel2003,andthensavingtheworkbookasanXMLSpreadsheetfile.SettingtheMapDatapropertywillreplaceanyexistingschemamapwiththenewschemamapyouspecify.

ExampleThefollowingexampleusestheMapDatapropertyoftheXmlMapobjecttoreturntheschemamap:

DimobjMapDimstrMapData

ForEachobjMapinSpreadsheet1.ActiveWorkbook.XmlMaps'Savethexmlmapinformationtoavariable.strMapData=objMap.MapData'Workwithmapinfoxmlhere.Next

ThenextexampleisafunctionthatsetstheMapDataproperty:

FunctionChangeMapSchema(objMap,strMapData)OnErrorResumeNextobjMap.MapData=strMapData

IfErr.Number<>0Then ChangeMapSchema=True Else ChangeMapSchema=False EndIfEndFunction

MarkerProperty

ReturnsaChMarkerobjectthatrepresentsthemarkersforeverypointinthespecifiedseries.Read-only.

expression.Marker

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

ExampleThisexamplesetsthecharttypeandthensetsthemarkertypeandinteriorcolorforthespecifiedseries.

SubSetMarkerStyle()DimchConstantsDimserSeries1

SetchConstants=ChartSpace1.Constants

SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

ChartSpace1.Charts(0).Type=chConstants.chChartTypeLineMarkers

serSeries1.Marker.Style=chConstants.chMarkerStyleSquare

serSeries1.Interior.Color="blue"EndSub

ShowAll

MaxHeightProperty

MaxHeightpropertyasitappliestothePivotTableobject.

MaxHeightpropertyasitappliestotheSpreadsheetobject.

MaximumProperty

Returnsorsetsthemaximumvalueforthespecifiedscale.Read/writeDouble.

expression.Maximum

expressionRequired.AnexpressionthatreturnsaChScalingobject.

ExampleThisexamplesetsthemaximumandminimumvaluesforthespecifiedaxisscale.

SubSetScalingLimits()DimchConstantsDimaxisScale

SetchConstants=ChartSpace1.Constants

SetaxisScale=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).Scaling

axisScale.Maximum=70axisScale.Minimum=-10EndSub0

MaxRecordsProperty

Returnsorsetsthemaximumnumberofrecordsthattheconnectionwillreturntothelocalcomputer.Read/writeLong.

expression.MaxRecords

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ShowAll

MaxWidthProperty

MaxWidthpropertyasitappliestothePivotTableobject.

MaxWidthpropertyasitappliestotheSpreadsheetobject.

ShowAll

MemberProperty

MemberpropertyasitappliestothePivotResultColumnAxis,PivotResultGroupAxis,PivotResultPageAxis,andPivotResultRowAxisobjects.

MemberpropertyasitappliestothePivotFieldSetobject.

MemberCaptionsProperty

ReturnsorsetsanarrayofVariantvaluesthatcontainsthecaptionsofthemembersinthespecifiedfield.Usethispropertytocustomizethecaptionsofthemembersinafield.Read/write.

expression.MemberCaptions

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksThearraythatyoupasstothispropertycontainsanarrayforeachcaptionthatyouwanttomodify.Thefirstelementinthearraycancontaineitheramembername,uniquename,orareferencetoaPivotMemberobject.Thesecondelementinthearrayisthenewcaptiontobeusedforthemember.

Membersnotspecifiedinthearraywillusethedefaultcaptionsprovidedbythedatasource.

NoteThispropertywillworkonlywithOnlineAnalyticalProcessing(OLAP)datasources.

ExampleThisexamplereplacesthecaptionsintheStateProvincefieldoftheCustomersfieldsetwithcaptionsthataremorereadable.

SubNewMemberCaptions()

DimfldStateCaptionsDimavarNewCaptions(2)

SetfldStateCaptions=PivotTable1.ActiveView.FieldSets("Customers")_.Fields("StateProvince")

'Thefollowingthreelinesofcodespecifythenewcaptionsto'bedisplayedforthestatesintheStateProvincefield.avarNewCaptions(0)=Array("[StateProvince].[CA]","California")avarNewCaptions(1)=Array("[StateProvince].[WA]","Washington")avarNewCaptions(2)=Array("[StateProvince].[OR]","Oregon")

'ApplythenewcaptionstotheStateProvincefield.fldStateCaptions.MemberCaptions=avarNewCaptions

EndSub

ShowAll

MemberPropertiesProperty

MemberPropertiespropertyasitappliestothePivotFieldobject.

MemberPropertiespropertyasitappliestothePivotAxisMember,PivotColumnMember,PivotPageMember,andPivotRowMemberobjects.

ExampleAsitappliestothePivotFieldobject.

MemberPropertiesOrderProperty

ReturnsorsetsanarrayofVariantvaluesthatrepresentstheorderthatthememberpropertiesaretobedisplayedinthespecifiedfield.Usethispropertytorearrangetheorderthatmemberpropertiesaredisplayedin.Read/write.

expression.MemberPropertiesOrder

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksThearraythatyoupasstothispropertycancontainalistofPivotMemberPropertyobjectsoraStringlistofmembercaptions.

ExampleThisexampleenablesthemembercaptionsfortheStoreNamefieldinPivotTable1.Then,themembercaptionsarerearranged,andtheircaptionsarecustomized.

SubFormat_MemberProperties()DimptViewDimptConstantsDimfldStoreName

SetptConstants=PivotTable1.Constants

'SetavariabletotheactiveviewofthePivotTable.SetptView=PivotTable1.ActiveView

'SetavariabletotheStoreNamefield.SetfldStoreName=ptView.FieldSets("Store").Fields("StoreName")

'Thefollowingthreelinesofcodespecifythatthememberpropertiesare'displayedinthePivotTablelist.fldStoreName.MemberProperties("StoreManager").DisplayIn=ptConstants.plDisplayPropertyInReportfldStoreName.MemberProperties("StoreType").DisplayIn=ptConstants.plDisplayPropertyInReportfldStoreName.MemberProperties("StoreSqft").DisplayIn=ptConstants.plDisplayPropertyInReport

fldStoreName.MemberPropertiesOrder=Array("StoreType","StoreSqft","StoreManager")

'Thefollowingthreelinesofcodesetthecaptionforthememberproperties.fldStoreName.MemberProperties("StoreManager").Caption="ManagerName"fldStoreName.MemberProperties("StoreType").Caption="StoreType"fldStoreName.MemberProperties("StoreSqft").Caption="SizeinSQFT"EndSub

MemberPropertyProperty

ReturnsaPivotMemberPropertyobjectthatrepresentsthememberpropertyofthespecifiedresultmember.

expression.MemberProperty

expressionRequired.AnexpressionthatreturnsaPivotResultMemberPropertyobject.

MergeAreaProperty

ReturnsaRangeobjectthatrepresentsthemergedrangecontaininganypartofthespecifiedrange.Thespecifiedrangecancontainmorethanonecell;iftherangedoesnotcontainanymergedcells,itisreturnedunchanged.Read-only.

expression.MergeArea

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplecreatesamergedcellfromtherangeB2:C5inSheet1andputsathickredborderaroundthemergedcell.

SubMerge_Cells()DimssConstantsDimshtCurrentSetssConstants=Spreadsheet1.ConstantsSetshtCurrent=Spreadsheet1.Worksheets("Sheet1")'MergecellsB2:C5.shtCurrent.Range("B2:C5").Merge'Setthebordercolorofthemergedcell.shtCurrent.Range("B2").MergeArea.Borders.Color="Red"'Settheborderweightofthemergedcell.shtCurrent.Range("B2").MergeArea.Borders.Weight=ssConstants.owcLineWeightThickEndSub

MergeCellsProperty

Trueifthespecifiedrangeiswithinamergedcell.Falseifthespecifiedrangedoesnotcontainamergedcell.Nullifthespecifiedrangecontainsallorpartofamergedcellandothercellsoutsideofthemergedcell.Read/writeVariant.

expression.MergeCells

expressionRequired.AnexpressionthatreturnsaRangeobject.

RemarksWhenyouselectarangethatcontainsmergedcells,theresultingselectionmaybedifferentfromtheintendedselection.

UsetheAddresspropertytochecktheaddressoftheselectedrange.

UsetheUnMergemethodtounmergethespecifiedrange.

MinimumProperty

Returnsorsetstheminimumvalueforthespecifiedscale.Read/writeDouble.

expression.Minimum

expressionRequired.AnexpressionthatreturnsaChScalingobject.

ExampleThisexamplesetsthemaximumandminimumvaluesforthespecifiedaxisscale.

SubSetScalingLimits()DimchConstantsDimaxisScale

SetchConstants=ChartSpace1.Constants

SetaxisScale=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).Scaling

axisScale.Maximum=70axisScale.Minimum=-10EndSub

MinorGridlinesProperty

ReturnsaChGridlinesobjectthatrepresentstheminorgridlinesforthespecifiedaxis.Notethatyoucanusegridlinesonanyaxis.Read-only.

expression.MinorGridlines

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetsthecolorandlineweightforthegridlinesonthevalueaxisofthefirstchartinChartSpace1.

SubFormat_Gridlines()DimchConstantsDimglMajorGridlinesDimglMinorGridlines

SetchConstants=ChartSpace1.Constants

'Setavariabletothemajorgridlinesonthevalueaxis.SetglMajorGridlines=ChartSpace1.Charts(0).Axes(_chConstants.chAxisPositionValue).MajorGridlines

'Setavariabletotheminorgridlinesonthevalueaxis.SetglMinorGridlines=ChartSpace1.Charts(0).Axes(_chConstants.chAxisPositionValue).MinorGridlines

'Setthecolorandweightofthemajorgridlines.glMajorGridlines.Line.Color="white"glMajorGridlines.Line.Weight=5

'Setthecolorandweightoftheminorgridlines.glMinorGridlines.Line.Color="yellow"glMajorGridlines.Line.Weight=2EndSub

ShowAll

MinorTickMarksProperty

Returnsorsetstheminortick-marktypeforthespecifiedaxis.Read/writeChartTickMarkEnum.

expression.MinorTickMarks

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleturnsonminorgridlinesandminortickmarksforthespecifiedaxisandsetsthegridlinecolorandtick-markstyle.

SubFormatValueAxis()DimchConstantsDimaxValueAxis

SetchConstants=ChartSpace1.Constants

SetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionLeft)

axValueAxis.HasMinorGridlines=True

axValueAxis.MinorGridlines.Line.Color="green"

axValueAxis.MinorTickMarks=chConstants.chTickMarkOutsideEndSub

MinorUnitProperty

Returnsorsetstheminorunitforthespecifiedaxis.Usethispropertyonlywithavalueaxis.Read/writeDouble.

expression.MinorUnit

expressionRequired.AnexpressionthatreturnsaChAxisobject.

RemarksSettingthispropertycausestheHasAutoMinorUnitpropertytobesettoFalse.

ExampleThisexamplesetsthemajorandminorunitforthevalueaxis.

SubSetValueAxis()DimchConstantsDimaxValueAxis

SetchConstants=ChartSpace1.Constants

SetaxValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue)

axValueAxis.MajorUnit=7axValueAxis.MinorUnit=2.5EndSub

MinorVersionProperty

ReturnstheminorversionoftheMicrosoftOfficeWebComponentsobjectlibrary.Read-onlyString.

expression.MinorVersion

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ShowAll

MiterProperty

ReturnsorsetsaChartLineMiterEnumconstantindicatingthewaythataline'sexterioredgesarejoined.Read/write.

expression.Miter

expressionRequired.AnexpressionthatreturnsaChLineobject.

ExampleThisexamplechangesthefirstchartinChartspace1toalinechartandthenformatsthelineforthefirstdataseriesinthechart.

SubSet_Series_LineStyle()

DimchConstantsDimserSeries1

SetchConstants=ChartSpace1.Constants

'Changethecharttoalinechart.ChartSpace1.Charts(0).Type=chChartTypeLine

'Setavariabletorefertothefirstdataseriesinthechart.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Setthemiterofthelineofthefirstseries.serSeries1.Line.Miter=chConstants.chLineMiterBevel

'Setthelineweightofthefirstseries.serSeries1.Line.Weight=chConstants.owcLineWeightThick

'Setthelinestyleofthefirstseries.serSeries1.Line.DashStyle=chConstants.chLineRoundDot

EndSub

MoveAfterReturnProperty

DetermineswhethertheactivecellwillbemovedwhentheuserpressestheENTERkey.ThedefaultvalueisTrue.UsetheMoveAfterReturnDirectionpropertytodeterminewhichdirectiontheactivecellmoveswhentheuserpressesENTER.Read/writeBoolean.

expression.MoveAfterReturn

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexamplecausestheactivecelltoremainselectedaftertheuserpressestheENTERkey.

Spreadsheet1.MoveAfterReturn=False

ShowAll

MoveAfterReturnDirectionProperty

ReturnsorsetsthedirectioninwhichthefocusismovedwhentheuserpressestheENTERkeyandtheMoveAfterReturnpropertyissettoTrue.Read/writeXlDirection.

expression.MoveAfterReturnDirection

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexamplecausesthecelltotherightoftheactivecelltobeselectedaftertheuserpressestheENTERkey.

SubMoveAfterEnter()DimssConstantsSetssConstants=Spreadsheet1.Constants'EnabletheMoveAfterReturnproperty.Spreadsheet1.MoveAfterReturn=True'Movethecursoronecelltotherightwhen'theuserpressesENTER.Spreadsheet1.MoveAfterReturnDirection=xlToRightEndSub

NameProperty

Returnsorsetsthenameofthespecifiedobject.

Read/writeVariantfortheFontobject.

Read/writefortheRangeobject.ReturnsaNameobject.SetusingaString.

Read/writeStringfortheChAxis,ChChart,ChFont,ChSeries,GroupingDef,Name,PageField,PivotFont,PivotHyperlink,PivotTotal,RecordsetDef,SchemaField,SchemaRowsource,andWorksheetobjects.

Read-onlyStringforallotherobjectsintheAppliesTolist.

expression.Name

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsthenameofthespecifiedchart.

ChartSpace1.Charts(0).Name="LineChart"

Afterthechartnamehasbeenset,youcanrefertothechartbyname,asshowninthefollowingexample.

ChartSpace1.Charts("LineChart").HasLegend=True

ShowAll

NamesProperty

NamespropertyasitappliestotheSpreadsheetandWorkbookobjects.

NamespropertyasitappliestotheWorksheetobject.

ExampleAsitappliestotheSpreadsheetandWorkbookobjects.

ShowAll

NextProperty

NextpropertyasitappliestotheRangeobject.

NextpropertyasitappliestotheWorksheetobject.

ExampleAsitappliestotheRangeobject.

NextSectionProperty

ReturnsaSectionobjectthatrepresentsthenextphysicalsectiononthespecifiedpage,regardlessofsiblingsorparents.Thispropertyfailsonthefinalsectiononthepage.Read-only.

expression.NextSection

expressionRequired.AnexpressionthatreturnsaSectionobject.

NextSiblingProperty

ReturnsaSectionobjectthatrepresentsthenextsiblinginthecurrentdataaccesspage.Thismaycausethenextpageofrecordstopopulateitself.Thispropertywillnotcrossparents,anditwillfailonthelastsiblingofthecurrentdataaccesspage.

expression.NextSibling

expressionRequired.AnexpressionthatreturnsaSectionobject.

NumberFormatProperty

Returnsorsetsthenumberformatforthespecifiedobject.Read/writeVariantfortheRangeobject;read/writeStringforallotherobjectsintheAppliesTolist.

expression.NumberFormat

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksYoucandefineanumberformatbyusingthesameformatcodesasMicrosoftExcel.Forinformationonnumberformatcodes,seethe"Createordeleteacustomnumberformat"topicinMicrosoftExcelHelp.

ExampleThefollowingexamplesetsthenumberformatfortherangesA1:E10andF1:F10ontheactiveworksheet.

SubFormatCells()

Spreadsheet1.ActiveSheet.Range("A1:E10").NumberFormat="0.###"Spreadsheet1.ActiveSheet.Range("F1:F10").NumberFormat="Currency"

EndSub

NumericScaleProperty

Returnsthemaximumnumberofdigitsyoucanhavetotherightofthedecimalpointfornumerictypes.Read-onlyLong.

expression.NumericScale

expressionRequired.AnexpressionthatreturnsaSchemaParameterobject.

ShowAll

ObjectTypeProperty

ReturnsaChartSelectionsEnumthatrepresentsthetypeofobjectthatiscurrentlyselected.

expression.ObjectType

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

OfflineProperty

ReturnsaBooleanindicatingwhetherMicrosoftInternetExplorerisinofflinemode.Read-only.

expression.Offline

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ExampleThisexamplechangesthetextofalabelcontroltoindicatetheofflinestatusofadataaccesspagebeforethedataaccesspageisboundtoitsdatasource.

SubMSODSC_BeforeInitialBind(DSCEventInfo)

IfMSODSC.Offline=TruethenLabel.innerText="Offline"ElseLabel.innerText="Online"EndIf

EndSub

OfflinePublicationProperty

ReturnsorsetsaStringthatrepresentsthepublicationtousewhenthedataaccesspageistakenoffline.Read/write.

expression.OfflinePublication

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RemarksThispropertyisvalidonlywhentheOfflineTypepropertyissettodscOfflineMerge.

OfflineSourceProperty

ReturnsorsetsaStringthatrepresentsthedatasourceusedwhenthedataaccesspageisoffline.Read/write.

expression.OfflineSource

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RemarksThevalueusedtosetthispropertyvariesbaseduponthecurrentsettingoftheOfflineTypeandXMLLocationproperties.IftheOfflineTypepropertyissettodscOfflineMerge,thenthispropertyshouldbesettoaconnectionstringforthelocalMSDEdatabase.IftheOfflineTypepropertyissettodscOfflineXMLDataFileandtheXMLLocationpropertyissettodscXMLDataFile,thenthispropertyshouldbesettoastringcontainingthepathtotheXMLdatafile.

ExampleThisexamplesetstheofflinesettingsfromthedatasourcecontrolnamedMSODSC.

SubSetOfflineSettings()

DimdscConstants

SetdscConstants=MSODSC.Constants

'Settheofflinetype.MSODSC.OfflineType=dscConstants.dscOfflineXMLDataFile

'SetthelocationoftheXMLdatatoadatafile.MSODSC.XMLLocation=dscconstants.dscXMLDataFile

'SettheXMLdatafiletousewhenthepageisoffline.MSODSC.OfflineSource="Q1SalesAnalysis.xml"

EndSub

ShowAll

OfflineTypeProperty

ReturnsorsetsaDscOfflineTypeEnumconstantthatrepresentsthetypeofconnectionusedtopersistthedatawhenadataaccesspageistakenoffline.Read/write.

expression.OfflineType

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ExampleThisexamplesetstheofflinesettingsfromthedatasourcecontrolnamedMSODSC.

SubSetOfflineSettings()

DimdscConstants

SetdscConstants=MSODSC.Constants

'Settheofflinetype.MSODSC.OfflineType=dscConstants.dscOfflineXMLDataFile

'SetthelocationoftheXMLdatatoadatafile.MSODSC.XMLLocation=dscconstants.dscXMLDataFile

'SettheXMLdatafiletousewhenthepageisoffline.MSODSC.OfflineSource="Q1SalesAnalysis.xml"

EndSub

OffsetProperty

ReturnsaRangeobjectthatrepresentsarangethatisoffsetfromthespecifiedrange.

expression.Offset(RowOffset,ColumnOffset)

expressionRequired.AnexpressionthatreturnsaRangeobject.

RowOffsetOptionalVariant.Thenumberofrows(positive,negative,or0(zero))bywhichtherangeistobeoffset.Positivevaluesareoffsetdownward,andnegativevaluesareoffsetupward.Thedefaultvalueis0.

ColumnOffsetOptionalVariant.Thenumberofcolumns(positive,negative,or0(zero))bywhichtherangeistobeoffset.Positivevaluesareoffsettotheright,andnegativevaluesareoffsettotheleft.Thedefaultvalueis0.

ExampleThisexamplesetsthefontforthecontentsofthecellthatisonecolumntotherightoftheactivecell.

Spreadsheet1.ActiveCell.Offset(0,1).Font.Bold=True

ThisexampleloopsthroughthecontiguousvaluesincolumnAintheactivesheetofSpreadsheet1anddeletesanyrowsthatcontainodd-numberedvalues.

SubDelete_Odd_Values()

Spreadsheet1.ActiveSheet.Range("A1").Select

'Loopuntilanemptycellisselected.DoUntilIsEmpty(Spreadsheet1.ActiveCell)

'Iftheactivecellcontainsanoddnumber.IfSpreadsheet1.ActiveCell.ValueMod2=1Then'Deletetherow.Spreadsheet1.ActiveCell.EntireRow.DeleteElse'Selectthenextcell.Spreadsheet1.ActiveCell.Offset(1,0).SelectEndIfLoopEndSub

ShowAll

OneSideProperty

OneSidepropertyasitappliestothePageRelatedFieldobject.

OneSidepropertyasitappliestothePageRelationshipobject.

OneSidepropertyasitappliestotheSchemaRelatedFieldandSchemaRelationshipobjects.

OrderProperty

Returnsorsetsthepolynomialorderforthespecifiedtrendline(anintegervaluegreaterthan1).Ifyousetthispropertyforalineartrendline,itbecomesapolynomialtrendline.Read/writeLong.

expression.Order

expressionRequired.AnexpressionthatreturnsaChTrendlineobject.

ExampleThisexamplesetstheorderforthespecifiedtrendline.

ChartSpace1.Charts(0).SeriesCollection(0).Trendlines(0).Order=2

OrderedMembersProperty

ReturnsorsetsaVariantthatdetermineshowthemembersofafieldaresortedwhentheSortDirectionpropertyissettoplSortDirectionCustom,plSortDirectionCustomAscending,orplSortDirectionCustomDescending.SetthispropertytoanarrayofmembersthatisorderedinthewaythatyouwantthemtoappearinthePivotTablelist.Whensettingthisproperty,youcanpassanarrayofmembernames,memberuniquenames,ormemberobjectreferences.Whenretrievingthisproperty,thearraywillalwayscontainPivotMemberobjectreferences.Read/write.

expression.OrderedMembers

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksAnymembersinthefieldthatarenotlistedinthisarraywillappearbelowthelastmemberlistedinthearray.

Settingthispropertyreplacesthecurrentlist.Toadditemstoanexistinglist,youmustretrievethelistandaddaddmemberstoit,oruseavariabletoholdthecurrentlist,appendtoit,andresetthisproperty.

Itisallowabletopassmembernamesoruniquenamesthatcurrentlydonotexistinthedataresults.Ifyoupassanameoruniquenamethatcannotberesolvedtoaresultingmember,itwillbeconvertedtoaPivotMemberobjectwithitsIsValidpropertysettoFalse.

Toclearthislist,setthispropertytoEmptyoranarrayofzeroelements.

ExampleThisexamplecreatesacustomsortorderintheTitlefield.

SubCustomSort()

DimptConstantsDimptViewDimpfTitle

SetptConstants=PivotTable1.Constants

SetptView=PivotTable1.ActiveView

'SetavariabletotheTitlefield.SetpfTitle=ptView.FieldSets("Title").Fields("Title")

'SpecifytheorderingforsomeoftheitemsintheTitlefield.pfTitle.OrderedMembers=Array("SalesRepresentative",_"SalesManager","VicePresident,Sales")

'Setthesortdirection.pfTitle.SortDirection=ptConstants.plSortDirectionCustom

EndSub

ShowAll

OrientationProperty

PivotFieldSetobject:ReturnsaPivotFieldSetOrientationEnumconstantthatrepresentsthefieldsetorientation.Afieldsetcanbelocatedonboththesummaryaxisandthecolumn,row,orfilteraxisatthesametime.Read-only.

ChAxisobject:ReturnsorsetsaLongthatrepresentstheorientationofthelabelsonthespecifiedaxis.CanbeaChartLabelOrientationEnumconstant.Read/write.

ChScalingobject:ReturnsorsetsaChartScaleOrientationEnumconstantthatrepresentsthescalingorientation.Changingthevalueofthispropertyflipsthechart.Read/write.

expression.Orientation

expressionRequired.AnexpressionthatreturnsoneoftheobjectintheAppliesTolist.

ExampleThisexamplesetsthescalingorientationforthespecifiedaxis.

SubSetAxisOrientation()

DimchConstants

SetchConstants=ChartSpace1.Constants

ChartSpace1.Charts(0).Axes(1).Scaling.Orientation=chConstants.chScaleOrientationMaxMin

EndSub

OverlapProperty

Returnsorsetstheamountofoverlapbetweenmarkerswithinasinglecategory.Positivevaluescausethemarkerstooverlap,andnegativevaluescausethemarkerstoseparate.Thedefaultvalueiszero(0),andthevalidrangeisfrom–100through100.Read/writeLong.

expression.Overlap

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetstheoverlapvalueforthespecifiedchart.

ChartSpace1.Charts(0).Overlap=25

PageAxisProperty

PivotViewobject:ReturnsaPivotGroupAxisobjectthatrepresentsthepageaxis.

PivotDataobject:ReturnsaPivotResultGroupAxisobjectthatrepresentsthepageaxis.

expression.PageAxis

expressionRequired.AnexpressionthatreturnsaPivotVieworPivotDataobject.

PageFieldsProperty

ReturnsthePageFieldscollectionforthespecifiedrecordsetdefinition.

expression.PageFields

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

PageMemberProperty

PivotCellobject:ReturnsaPivotPageMemberobjectthatrepresentsthepagememberforthespecifiedcell.

PivotResultPageAxisobject:ReturnsaPivotPageMemberobjectthatrepresentsthepagememberforthespecifiedresultaxis.

expression.PageMember

expressionRequired.AnexpressionthatreturnsaPivotCellorPivotResultPageAxisobject.

PageRelatedFieldsProperty

ReturnsthePageRelatedFieldscollectionforthespecifiedpagerelationship.Read-only.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

expression.PageRelatedFields

expressionRequired.AnexpressionthatreturnsaPageRelationshipobject.

PageRowsourceProperty

ReturnsthePageRowsourceobjectforthespecifiedpagefield.Read-only.

expression.PageRowsource

expressionRequired.AnexpressionthatreturnsaPageFieldobject.

PageRowsourcesProperty

ReturnsthePageRowsourcescollectionforthespecifiedrecordsetdefinition.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

expression.PageRowsources

expressionRequired.AnexpressionthatreturnsaRecordsetDefobject.

PanesProperty

ReturnsthePanescollectionforthespecifiedworksheet.

expression.Panes

expressionRequired.AnexpressionthatreturnsaWindowobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ExampleThisexamplesetsavariableforthevisiblerangeinthespecifiedpaneanddisplaystherange'slocation.

SubSetVisibleRange()

DimrngVisible

SetrngVisible=Spreadsheet1.ActiveSheet.Panes(1).VisibleRange

MsgBox"rngVisible.Address"&vr.Address

EndSub

ParameterValuesProperty

ReturnstheParameterValuescollectionforthespecifiedrecordsetdefinition.

expression.ParameterValues

expressionRequired.AnexpressionthatreturnsaRecordsetDefobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ParentProperty

Returnstheparentobjectforthespecifiedobject.

expression.Parent

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleTheeventprocedureinthisexamplerunswhenevertheuserclicksinthechartworkspace.

SubChartSpace1_Click()

DimchConstantsDimiSeriesNumDimiPointNum

SetchConstants=ChartSpace1.Constants

IfChartSpace1.SelectionType=chConstants.chSelectionPointThen'Pointparentisseries.iSeriesNum=ChartSpace1.Selection.Parent.Index

iPointNum=ChartSpace1.Selection.Index

MsgBox"Series:"&iSeriesNum&"Point:"&iPointNumEndIf

EndSub

ParentAxisMemberProperty

ReturnsaPivotAxisMemberobjectthatrepresentstheparentmemberforthespecifiedaxismember.

expression.ParentAxisMember

expressionRequired.AnexpressionthatreturnsaPivotAxisMemberobject.

RemarksThispropertyreturnsNothingifthispropertyisusedforthetoplevelaxismember.

ParentColumnMemberProperty

ReturnsaPivotColumnMemberobjectthatrepresentstheparentmemberforthespecifiedcolumnmember.

expression.ParentColumnMember

expressionRequired.AnexpressionthatreturnsaPivotColumnMemberobject.

RemarksThispropertyreturnsNothingifthispropertyisusedforthetoplevelcolumnmember.

ParentLabelProperty

ReturnsaChCategoryLabelobjectthatrepresentstheparentlabelforthespecifiedlabel.

expression.ParentLabel

expressionRequired.AnexpressionthatreturnsaChCategoryLabelobject.

RemarksUsingthispropertywithalabelthatdoesnothaveaparentlabelwillresultinarun-timeerror.

ParentMemberProperty

ReturnsaPivotMemberobjectthatrepresentstheparentmemberforthespecifiedmember.

expression.ParentMember

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ParentPageMemberProperty

ReturnsaPivotPageMemberobjectthatrepresentstheparentmemberforthespecifiedpagemember.

expression.ParentPageMember

expressionRequired.AnexpressionthatreturnsaPivotPageMemberobject.

ParentRecordsetDefProperty

ReturnsaRecordsetDefobjectthatrepresentstheparentforthespecifiedrecordsetdefinition.

expression.ParentRecordsetDef

expressionRequired.AnexpressionthatreturnsaRecordsetDefobject.

ParentRowMemberProperty

ReturnsaPivotRowMemberobjectthatrepresentstheparentmemberforthespecifiedrowmember.

expression.ParentRowMember

expressionRequired.AnexpressionthatreturnsaPivotRowMemberobject.

RemarksThispropertyreturnsNothingifthispropertyisusedforthetoplevelrowmember.

ParentSectionProperty

ReturnsaSectionobjectthatrepresentstheparentofthespecifiedsection.

expression.ParentSection

expressionRequired.AnexpressionthatreturnsaSectionobject.

ShowAll

PathProperty

ReturnsaStringthatrepresentsthepathtothespecifiedmember.Read-only.

expression.Path(Format)

expressionRequired.AnexpressionthatreturnsaPivotMemberobject.

FormatRequiredPivotMemberFindFormatEnum.

ShowAll

PatternProperty

ReturnsaChartPatternTypeEnumconstantindicatingthefillpatternforthespecifiedChInteriorobject.Read-only.

expression.Pattern

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksUsetheSetPatternedmethodtosetthepatternforaChInteriorobject.

PercentCompleteProperty

ReturnsaLongvaluethatrepresentsthecompletedportionofthecurrentoperation.ThispropertyissupportedonlyintheRecordsetSaveProgressevent.Read-only.

expression.PercentComplete

expressionRequired.AnexpressionthatreturnsaDSCEventInfoobject.

RemarksUsethispropertywiththeRecordsetSaveProgresseventtoupdateacontrolinthecontainer,suchasthestatusbar.

Usingthispropertywithanunsupportedeventwillresultinarun-timeerror.

ExampleThisexampleusestheRecordsetSaveProgesseventtoupdatetheMicrosoftInternetExplorer'sstatusbarwhentherecordsetcontainedbytheDataSourceControlobjectissaved.

SubMSODSC_RecordsetSaveProgress(DSCEventInfo)

'Updatethestatusbarwiththecurrent'completionpercentage.Window.Status=DSCEventInfo.PercentComplete

'Checktoseeifthesavehasbeencompleted.IfDSCEventInfo.PercentComplete=100then

'Clearthestatusbarwhenthesaveiscomplete.Window.Status=""EndIf

EndSub

PeriodProperty

ReturnsorsetsaLongthatrepresentstheperiodforamoving-averagetrendline.Read/write.

expression.Period

expressionRequired.AnexpressionthatreturnsaChTrendlineobject.

PerspectiveProperty

ReturnsorsetsaLongindicatingtheamountofperspectiveonathree-dimensionalchart.ThispropertyhasnoeffectiftheProjectionModepropertyofthecharthasbeensettochProjectionModeOrthographic.Validvaluesrangefrom0to80.Read/write.

expression.Perspective

expressionRequired.AnexpressionthatreturnsaChChartobject

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthensetstheperspectiveforthechart.

SubSetPerspective()

Dimcht3DColumn

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3-DColumnchart.cht3DColumn.Type=chChartTypeColumnClustered3D

'Settheperspective.cht3DColumn.Perspective=35

EndSub

PivotAxisProperty

ReturnsthePivotResultGroupAxisobjectforthespecifiedcategorylabelordataseries.

expression.PivotAxis

expressionRequired.AnexpressionthatreturnsaChCategoryLabelsorChSeriesCollectionobject.

ShowAll

PivotObjectProperty

PivotObjectpropertyasitappliestotheChPointobject.

PivotObjectpropertyasitappliestotheChCategoryLabel,ChChartField,ChLegendEntry,andChSeriesobjects.

RemarksThispropertyreturnsNullifthechartisnotboundtoarelationaldatasource.

ShowAll

PlotAllAggregatesProperty

ReturnsorsetsaChartPlotAggregatesEnumconstantthatdetermineswhichfieldsareplottedwhenthechartcontrolisboundtoarelationaldatasource.Read/write.

expression.PlotAllAggregates

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksThispropertyisrelevantonlywhenmultiplefieldshavebeenaddedtothedataareaofthechart.

PlotAreaProperty

ReturnsaChPlotAreaobjectthatrepresentstheplotareaonthespecifiedchart.Notethatpie,doughnut,radar,andpolarchartsdonothaveplotareas.

expression.PlotArea

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexamplesetstheinteriorcolorfortheplotareaonthespecifiedchart.

ChartSpace1.Charts(0).PlotArea.Interior.Color="Green"

PointsProperty

ReturnstheChPointscollectionforthespecifiedseries.

expression.Points

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ExampleThisexamplesetstheinteriorcolorforpointtwointhespecifiedseries.

ChartSpace1.Charts(0).SeriesCollection(0).Points(2).Interior.Color="green"

ShowAll

PositionProperty

Returnsorsetsthepositionoftheobject.

Read/writeChartAxisPositionEnumfortheChAxisobject.

Read/writeChartDataLabelPositionEnumfortheChDataLabelsobject.

Read/writeChartLegendPositionEnumfortheChLegendobject.

Read/writeChartTitlePositionEnumfortheChTitleobject.

expression.Position

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampleputsthelegendforthespecifiedcharttotheleftoftheplotarea.

SubAddLegend()

DimchConstants

SetchConstants=ChartSpace1.Constants

'EnbablethelegendforthefirstchartinChartspace1.ChartSpace1.Charts(0).HasLegend=True

'Setthepositionofthelegend.ChartSpace1.Charts(0).Legend.Position=chConstants.chLegendPositionLeft

EndSub

PrecisionProperty

Returnsthemaximumnumberofdigitsyoucanusefornumerictypes.Read-onlyLong.

expression.Precision

expressionRequired.AnexpressionthatreturnsaSchemaParameterobject.

PrefixCharacterProperty

Returnstheprefixcharacterforthespecifiedrange.Returnsanapostrophe(')ifthespecifiedrangecontainsavaluethatwasprecededwithanapostrophewhenitwasenteredintotheworksheet.Returnsablankstringifthespecifiedrangedoesnotcontainaprefixcharacter.Read-onlyVariant.

expression.PrefixCharacter

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexampledeletesallprefixcharactersfromtheactiveworksheetinSpreadsheet1.

SubDelete_PrefixCharacters()DimrngCell

'Loopthroughallusedcellsintheactiveworksheet.ForEachrngCellInSpreadsheet1.ActiveSheet.UsedRange

'Ifaprefixcharacterexists,deleteit.IfrngCell.PrefixCharacter<>""ThenrngCell.Value=rngCell.ValueEndIfNextEndSub

ShowAll

PresetGradientTypeProperty

ReturnsaChartPresetGradientTypeEnumconstantindicatingthepresetgradienttypeforthespecifiedChInteriorobject.Read-only.

expression.PresetGradientType

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksUsetheSetPresetGradientmethodtosetthepresetgradienttypeforthefill.

ShowAll

PresetTextureProperty

ReturnsaChartPresetTextureEnumconstantindicatingthepresettextureforthespecifiedChInteriorobject.Read-only.

expression.PresetTexture

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksUsetheSetTexturedmethodtosetthepresettextureforaChInteriorobject.

ShowAll

PreviousProperty

PreviouspropertyasitappliestotheRangeobject.

PreviouspropertyasitappliestotheWorksheetobject.

ExampleAsitappliestotheRangeobject.

PreviousSectionProperty

ReturnsaSectionobjectthatrepresentstheprevioussectiononthespecifiedpage,regardlessofsiblingsorparents.Thispropertyfailsonthefirstsectionofthepage.

expression.PreviousSection

expressionRequired.AnexpressionthatreturnsaSectionobject.

PreviousSiblingProperty

ReturnsaSectionobjectthatrepresentstheprevioussiblinginthecurrentdataaccesspage.Thispropertyfailsonthefirstsiblingofthecurrentdataaccesspage.

expression.PreviousSibling

expressionRequired.AnexpressionthatreturnsaSectionobject.

PrimaryPageRowsourceProperty

ReturnsaPageRowsourceobjectthatrepresentstheprimarypagerowsourceforthespecifiedrecordsetdefinition.Whenarecordsetdefinitioniscreated,therowsourcenamedintheAddorAddNewmethodbecomestheprimarypagerowsource.

expression.PrimaryPageRowsource

expressionRequired.AnexpressionthatreturnsaRecordsetDefobject.

PrintQuality3DProperty

ReturnsorsetsaDoubleindicatingtheratiooftheprintedresolutionofathree-dimensional(3-D)charttotheresolutionofyourprinter.Validvaluesrangefrom0to1.Thedefaultvalueis0.25.Read/write.

expression.PrintQuality3D

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksThelowerthevalueofthisproperty,thefasteryour3-Dchartwillprint.However,settingthisvalueofthispropertytoolowmayyieldunsatisfactoryresults.

ExampleThisexamplesetsthe3-DchartsinChartspace1toprintat75%oftheprinter'sresolution.

Chartspace1.PrintQuality3D=0.75

ShowAll

ProjectionModeProperty

ReturnsorsetsaChartProjectionModeEnumconstantindicatingtheviewingperspectiveofathree-dimensionalchart.Read/write.

expression.ProjectionMode

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthensetstheprojectionmodeofthechart.

SubSetExtrudeAngle()

Dimcht3DColumnDimchConstants

SetchConstants=Chartspace1.Constants

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3DColumnchart.cht3DColumn.Type=chChartTypeColumnClustered3D

'Setstheprojectionmodetoorthographic.cht3DColumn.ProjectionMode=chConstants.chProjectionModeOrthographic

'Setstheextrusionangle.cht3DColumn.ExtrudeAngle=75

EndSub

PropertyCaptionFontProperty

ReturnsaPivotFontobjectthatrepresentsthefontsettingsusedtodisplaythecaptionofOLAPmemberpropertiesinthespecifiedview.Usethereturnedobjecttoformatthefontusedformemberpropertycaptions.

expression.PropertyCaptionFont

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

ExampleThisexampleformatsthealignmentandthefontofmemberpropertycaptionsandvaluesintheactiveviewofPivotTable1.

SubFormat_MemberProperties()

DimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'Thefollowingthreelinesofcodeformatthe'fontformemberpropertycaptions.ptView.PropertyCaptionFont.Name="Tahoma"ptView.PropertyCaptionFont.Size=8ptview.PropertyCaptionFont.Bold=True

'Left-alignthememberpropertycaptions.ptview.PropertyCaptionHAlignment=ptConstants.plHAlignLeft

'Thefollowingtwolinesofcodeformatthe'fontformemberpropertyvalues.ptview.PropertyValueFont.Name="Tahoma"ptview.PropertyValueFont.Size=8

'Right-alignthememberpropertyvalues.ptview.PropertyValueHAlignment=ptConstants.plHAlignRight

EndSub

ShowAll

PropertyCaptionHAlignmentProperty

ReturnsorsetsaPivotHAlignmentEnumconstantthatrepresentsthehorizontalalignmentofOLAPmemberpropertycaptionsinthespecifiedview.Usethispropertytosetthehorizontalalignmentofmemberpropertycaptions.Read/write.

expression.PropertyCaptionHAlignment

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

ExampleThisexampleformatsthealignmentandthefontofmemberpropertycaptionsandvaluesintheactiveviewofPivotTable1.

SubFormat_MemberProperties()

DimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'Thefollowingthreelinesofcodeformatthe'fontformemberpropertycaptions.ptView.PropertyCaptionFont.Name="Tahoma"ptView.PropertyCaptionFont.Size=8ptview.PropertyCaptionFont.Bold=True

'Left-alignthememberpropertycaptions.ptview.PropertyCaptionHAlignment=ptConstants.plHAlignLeft

'Thefollowingtwolinesofcodeformatthe'fontformemberpropertyvalues.ptview.PropertyValueFont.Name="Tahoma"ptview.PropertyValueFont.Size=8

'Right-alignthememberpropertyvalues.ptview.PropertyValueHAlignment=ptConstants.plHAlignRight

EndSub

PropertyCaptionWidthProperty

ReturnsorsetsaLongthatrepresentsthewidthofthecaptionofamemberpropertythatisdisplayedinthespecifiedfield.Read/write.

expression.PropertyCaptionWidth

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

PropertyHeightProperty

ReturnsorsetsaLongthatrepresentstheheightofamemberpropertythatisdisplayedinthespecifiedfield.Read/write.

expression.PropertyHeight

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

PropertyValueFontProperty

ReturnsaPivotFontobjectthatrepresentsthefontsettingsusedtodisplaythevalueofOLAPmemberpropertiesinthespecifiedview.Usethereturnedobjecttoformatthefontusedformemberpropertyvalues.

expression.PropertyValueFont

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

ExampleThisexampleformatsthealignmentandthefontofmemberpropertycaptionsandvaluesintheactiveviewofPivotTable1.

SubFormat_MemberProperties()

DimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'Thefollowingthreelinesofcodeformatthe'fontformemberpropertycaptions.ptView.PropertyCaptionFont.Name="Tahoma"ptView.PropertyCaptionFont.Size=8ptview.PropertyCaptionFont.Bold=True

'Left-alignthememberpropertycaptions.ptview.PropertyCaptionHAlignment=ptConstants.plHAlignLeft

'Thefollowingtwolinesofcodeformatthe'fontformemberpropertyvalues.ptview.PropertyValueFont.Name="Tahoma"ptview.PropertyValueFont.Size=8

'Right-alignthememberpropertyvalues.ptview.PropertyValueHAlignment=ptConstants.plHAlignRight

EndSub

ShowAll

PropertyValueHAlignmentProperty

ReturnsorsetsaPivotHAlignmentEnumconstantthatrepresentsthehorizontalalignmentofOLAPmemberpropertyvaluesinthespecifiedview.Usethispropertytosetthehorizontalalignmentofmemberpropertyvalues.Read/write.

expression.PropertyValueHAlignment

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

ExampleThisexampleformatsthealignmentandthefontofmemberpropertycaptionsandvaluesintheactiveviewofPivotTable1.

SubFormat_MemberProperties()

DimptViewDimptConstants

SetptConstants=PivotTable1.Constants

'SetavariabletothecurrentPivotTableview.SetptView=PivotTable1.ActiveView

'Thefollowingthreelinesofcodeformatthe'fontformemberpropertycaptions.ptView.PropertyCaptionFont.Name="Tahoma"ptView.PropertyCaptionFont.Size=8ptview.PropertyCaptionFont.Bold=True

'Left-alignthememberpropertycaptions.ptview.PropertyCaptionHAlignment=ptConstants.plHAlignLeft

'Thefollowingtwolinesofcodeformatthe'fontformemberpropertyvalues.ptview.PropertyValueFont.Name="Tahoma"ptview.PropertyValueFont.Size=8

'Right-alignthememberpropertyvalues.ptview.PropertyValueHAlignment=ptConstants.plHAlignRight

EndSub

PropertyValueWidthProperty

ReturnsorsetsaLongthatrepresentsthewidthofthevalueofamemberpropertythatisdisplayedinthespecifiedfield.Read/write.

expression.PropertyValueWidth

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

PropNamesProperty

ReturnsastringarraycontainingthevaluesoftheIDattributeforeachFieldelementintheschemamapfortheXMLlist(/Map/Entry/Field@ID)inleft-to-rightorder,whichcorrespondstotheorderingof/Field/Rangeelementsinthemap.Read-onlyVariant.

expression.PropNames

expressionRequired.AnexpressionthatreturnsaListObjectobject.

Remarks

ForXMLlistscreatedbysavingafilefromMicrosoftOfficeExcel2003asanXMLSpreadsheetfile,theIDvaluesreturnedbythePropNamepropertycorrespondtothecolumnnamesintheheaderrowoftheXMLlistrepresentedbytheListObjectobject.TheorderingofthevaluesreturnedinthearraydependsonthesettingoftheRightToLeftproperty.

ExampleThefollowingexampleshowshowtogetthecolumnnamesinalistwhentheactivecelliswithinthelist:

DimstrFieldNameDimobjListObject

SetobjListObject=Spreadsheet1.ActiveCell.ListObjectForEachstrFieldNameinobjListObject.PropNames'strFieldNamenowcontainselement(field)nameforacolumninthelist.Next

ProtectContentsProperty

Trueifthecontentsofthesheetareprotected.Read-onlyBoolean.

expression.ProtectContents

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

ProtectionProperty

ReturnsaProtectionobjectthatcontainstheprotectionpropertiesforthespecifiedworksheet.TheprotectionpropertiesareignorediftheEnabledpropertyissettoFalse.

expression.Protection

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

ExampleThisexamplelocksthecellsincolumnBandenablesprotectionforthesheet.

SubProtectColumnB()

'Unlockallofthecellsintheactivesheet.Spreadsheet1.ActiveSheet.Cells.Locked=False

'LockthecellsincolumnB.Spreadsheet1.Columns(2).Locked=True

'Protectthelockedcells.Spreadsheet1.ActiveSheet.Protection.Enabled=True

EndSub

ProtectionModeProperty

Trueifuser-interface-onlyprotectionisenabled.AlwaysreturnsTrue.Read-onlyBoolean.

expression.ProtectionMode

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

ProtectStructureProperty

Trueiftheorderofthesheetsintheworkbookisprotected.Read-onlyBoolean.

expression.ProtectStructure

expressionRequired.AnexpressionthatreturnsaWorkbookobject.

ProviderFormattedValueProperty

ReturnsaVariantthatrepresentsthevalueofthespecifiedaggregateasitisformattedbythedatasource.Read-only.

expression.ProviderFormattedValue

expressionRequired.AnexpressionthatreturnsaPivotAggregateobject.

ProviderTypeProperty

ReturnsaProviderTypeconstantthatrepresentsthetypeofdataproviderforthespecifiedPivotTablelist.Read-only.

expression.ProviderType

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

ShowAll

RangeProperty

AsitappliestotheAutoFilterobject.

AsitappliestothePivotDataobject.

AsitappliestotheRange,Spreadsheet,andWorksheetobjects.

AsitappliestotheListObjectobject.

AsitappliestotheListRowobject.

ExampleAsitappliestotheRange,Spreadsheet,andWorksheetobjects.

RangeSelectionProperty

ReturnsaRangeobjectthatrepresentstheselectedcellsontheworksheetinthespecifiedwindow.Read-only.

expression.RangeSelection

expressionRequired.AnexpressionthatreturnsaWindowobject.

RemarksThispropertyinidenticalinfunctionalitytotheSelectionproperty.

ExampleThisexamplesetssetsthefontoftheselectedcellstobold.

Spreadsheet1.ActiveWindow.RangeSelection.Font.Bold=True

ShowAll

ReadingOrderProperty

ReturnsorsetsaLongrepresentingthereadingorderforthespecifiedobject.CanbeaXlReadingOrderconstant.Read/write.

expression.ReadingOrder

expressionRequired.AnexpressionthatreturnsaRangeobject.

RemarksSomeoftheseconstantsmaynotbeavailabletoyou,dependingonthelanguagesupport(U.S.English,forexample)thatyou'veselectedorinstalled.

RecordNavigationSectionProperty

Trueifthereisanavigationsectionforanygivenbandingsection.ThedefaultvalueisTrue.Read/writeBoolean.

expression.RecordNavigationSection

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

RecordSelectorProperty

ReturnsorsetsaBooleanthatindicateswhetherornottodisplaytherecordselectorforthespecifiedgroup.Read/write.

expression.RecordSelector

expressionRequired.AnexpressionthatreturnsaGroupLevelobject.

RecordsetProperty

PivotCellobject:ReturnsanADORecordsetobjectthatcontainsthedetailrecordsforthecelliftheyareavailable.

PivotDataobject:ReturnsanADORecordsetobjectthatcontainsthedetailrecordsforthespecifiedPivotDataobjectiftheyareavailable.

DataPageobject:ReturnsanADORecordsetobjectforthespecifieddataaccesspage.

expression.Recordset

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RecordsetDefProperty

ReturnsthecontainingRecordsetDefobjectforthespecifiedpagefieldorpagerowsource.

expression.RecordsetDef

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RecordsetDefsProperty

ReturnstheRecordsetDefscollectionforthedatasourcecontrol.

expression.RecordsetDefs

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

RecordsetLabelProperty

Returnsorsetstherecordsetlabelfortherecordnavigationcontrolwhenthepageisnotbandedandonerecordisdisplayed,andwhenthepageisbandedandtwoormorerecordsaredisplayed.Read/writeString.

expression.RecordsetLabel

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

RemarksThelabelconsistsoftwostringsseparatedbyasemicolon.Thefirststringrepresentsthelabelthatisdisplayedwhenonerecordisdisplayedonthepage,andthesecondstringrepresentsthelabelthatisdisplayedwhentwoormorerecordsaredisplayedonthepage.Thelabelcancontainthefollowingplaceholdersfordisplayingrecordsetinformationonthepage.

Placeholder Description|0 Thenumberofthecurrentrecord,orthenumberofthefirst

visiblerecordinthegroup.|1 Thenumberofthelastvisiblerecordinthegroup.|2 Thenumberofrecordsintherecordset.

ExampleThisexamplesetstherecordsetlabel.Ifthepageisbandedandrecords1through5outof8aredisplayed,thelabelsays"Categories1-5of8."Ifthepageisnotbandedandthefirstrecordisdisplayed,thelabelsays"Category1of8."

ProductNavigation.RecordsetLabel=_"Category|1of|2;Categories|0-|1of|2"

ShowAll

RecordsetTypeProperty

Returnsorsetstherecordsettypeforthedatasourcecontrol.Read/writeDscRecordsetTypeEnum.

expression.RecordsetType

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RecordSourceProperty

ElementExtensionandGroupLevelobjects:ReturnsorsetsaStringthatrepresentstherecordsource(thenameofarecordsetdefinitionorgroupingdefinition)forthesection.AppliesonlytoDIVsections.Read/write.

RecordNavigationControlobject:ReturnsorsetsaDataMemberobjectthatrepresentstherecordsourceforthesection.Read/write.

expression.RecordSource

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RefersToProperty

Returnsorsetstheformulathatthenameasdefinedrefersto,inthelanguageofthescriptandinA1-stylenotation,beginningwithanequalsign.Read/writeVariant.

expression.RefersTo

expressionRequired.AnexpressionthatreturnsaNameobject.

ExampleThefollowingexamplecreatesalistofallthenamesintheactiveworkbook,alongwiththeformulastowhichtheyrefer.

SubList_All_Names()DimnmCurrentNameDimrngCurrent

SetrngCurrent=Spreadsheet1.ActiveSheet.Range("A1")

'Loopthroughallofthenamesintheactiveworkbook.ForEachnmCurrentNameInSpreadsheet1.ActiveWorkbook.Names

'Writethecurrentnametotheworksheet.rngCurrent.Value=nmCurrentName.Name

'Writethedefinitionofthecurrentnametotheworksheet.rngCurrent.Offset(0,1).Value="'"&nmCurrentName.RefersTo

SetrngCurrent=rngCurrent.Offset(1,0)NextEndSub

RefersToLocalProperty

ReturnsorsetsaVariantrepresentingtheformulathatthenamerefersto.Theformulaisinthelanguageoftheuser,andit'sinA1-stylenotation,beginningwithanequalssign.Read/write.

expression.RefersToLocal

expressionRequired.AnexpressionthatreturnsaNameobject.

ExampleThefollowingexamplecreatesalistofallthenamesintheactiveworkbook,alongwiththeformulastowhichtheyrefer,inthelanguageoftheuser.

SubList_All_Names()DimnmCurrentNameDimrngCurrent

SetrngCurrent=Spreadsheet1.ActiveSheet.Range("A1")

'Loopthroughallofthenamesintheactiveworkbook.ForEachnmCurrentNameInSpreadsheet1.ActiveWorkbook.Names

'Writethecurrentnametotheworksheet.rngCurrent.Value=nmCurrentName.Name

'Writethedefinitionofthecurrentnametotheworksheet.rngCurrent.Offset(0,1).Value="'"&nmCurrentName.RefersToLocal

SetrngCurrent=rngCurrent.Offset(1,0)NextEndSub

RefersToRangeProperty

ReturnstheRangeobjectreferredtobyaNameobject.IftheNameobjectdoesn'trefertoarange(forexample,ifitreferstoaconstantoraformula),thispropertygeneratesarun-timeerror.Read-only.

expression.RefersToRange

expressionRequired.AnexpressionthatreturnsaNameobject.

ResyncCommandProperty

SpecifiesanSQLcommandparameterizedbythekeyfieldvaluesfromthespecifiedrecordset’suniquetablesuchthatthecommandreturnsexactlyonerecord.Theresynccommandisexecutedto"fixup"arowafteranupdateorinsertionismade.Read/writeString.

expression.ResyncCommand

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksYoumustsetthispropertyforanyformbasedonastoredprocedurethatcontainsajoinorexpressioncolumn.Inallothercases,MicrosoftAccesscanfixtablesautomatically.Ifyoudonotsetthisproperty,userswillnotseefixed-upfieldvaluesafteranupdateorinsertion,buttheupdateorinsertionwillstillbeexecutedcorrectly.

ReturnValueProperty

Returnsorsetsthereturnvalueforthespecifiedevent.YoucancancelthedefaultactionforsomeeventsbysettingthispropertytoFalse.Read/writeBoolean.

expression.ReturnValue

expressionRequired.AnexpressionthatreturnsaDSCEventInfoobject.

ExampleThisexampleusestheBeforeInserteventtopreventtheuserfromaddinganotherrecordtotherecordsetonceitreaches75records.

SubMSODSC_BeforeInsert(DSCEventInfo)DimrstCurrentData

'Setavariabletotherecordset.SetrstCurrentData=DSCEventInfo.DataPage.Recordset

'Checktoseeiftherecordsethasreacheditslimit.IfrstCurrentData.RecordCount>=75then

'Displayamessagetotheuser.MsgBox"Cannotaddanymorerecords."

'Canceltheinsertionoftherecord.DSCEventInfo.ReturnValue=FalseEndIfEndSub

RevisionNumberProperty

ReturnstheMicrosoftOfficeWebComponentsrevisionnumber.Read-onlyString.

expression.RevisionNumber

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ShowAll

RightProperty

RightpropertyasitappliestotheChPlotAreaobject.

RightpropertyasitappliestotheChartSpace,ChAxis,ChCategoryLabel,ChChart,ChChartField,ChDataLabel,ChDataLabels,ChDropZone,ChErrorBars,ChLegend,ChLegendEntry,ChPoint,ChSeries,ChScrollView,ChTitle,andChTrendlineobjects.

RightToLeftProperty

Trueifright-to-leftlanguagesupportisenabled.Forexample,settingthispropertytoTruecausesscrollbarstobedisplayedontheleft.Read/writeBoolean.

expression.RightToLeft

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RotationProperty

ReturnsorsetsaDoubleindicatingtherotationindegreesofthespecifiedthree-dimensionalchart.Validvaluesrangefrom0to360.Read/write.

expression.Rotation

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthenrotatesthechart145degrees.

SubSetGapDepth()

Dimcht3DColumnAsChChart

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Changethecharttoa3-DColumnchart.cht3DColumn.Type=chChartTypeColumn3D

'Rotatethechart.cht3DColumn.Rotation=145

EndSub

RowProperty

Returnsthenumberofthefirstrowinthespecifiedrange.Read-onlyLong.

expression.Row

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplemakeseveryotherrowgreeninthecurrentregionforcellA1.

SubFormatRows()

DimrngCurrentRow

'Loopthroughalloftherowsinthecurrentregion.ForEachrngCurrentRowInSpreadsheet1.Cells(1,1).CurrentRegion.Rows

'Checktoseeiftherownumberisanevennumber.IfrngCurrentRow.RowMod2=0Then

'Settheinteriorcoloroftherow.rngCurrentRow.Interior.Color="LightGreen"EndIfNextEndSub

RowAxisProperty

PivotDataobject:ReturnsaPivotResultRowAxisobjectthatrepresentstherowaxis.

PivotViewobject:ReturnsaPivotGroupAxisobjectthatrepresentstherowaxis.

expression.RowAxis

expressionRequired.AnexpressionthatreturnsoneoftheobjectintheAppliesTolist.

ExampleThisexampleinsertstwofieldsetsintothePivotTablelistintheactiveview.

SubAddFieldsToPT()

DimptView

SetptView=PivotTable1.ActiveView

ptView.ColumnAxis.InsertFieldSetptView.FieldSets("StoreType")

ptView.RowAxis.InsertFieldSetptView.FieldSets("Promotions")

EndSub

RowHeadingsProperty

ReturnsaHeadingscollectionthatrepresentstherowheadingsinthespecifiedwindow.UsetheCaptionpropertytocustomizetherowheadings.

expression.RowHeadings

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplesetsthecreatesacustomdataentrysheetbydisablingsomeuserinterfaceelements,limitingtheviewablerangeintheactivewindow,andcustomizingtherowandcolumnheadings.

SubCreate_Datasheet()DimhdrColHeadingsDimhdrRowHeadingsDimwndActive

SetwndActive=Spreadsheet1.ActiveWindow

'HidevariousUIelements.wndActive.DisplayWorkbookTabs=FalseSpreadsheet1.DisplayToolbar=False

'Displaythetitlebarandsetit'scaption.Spreadsheet1.DisplayTitleBar=TrueSpreadsheet1.TitleBar.Caption="RevenueWorksheet"

'Resizethespreadsheetcomponent.Spreadsheet1.AutoFit=True

'Limittheviewablerangeoftheactivesheet.wndActive.ViewableRange="A1:D5"

'Setavariabletothecolumnheadingsintheactivewindow.SethdrColHeadings=wndActive.ColumnHeadings

'Setavariabletotherowheadingsintheactivewindow.SethdrRowHeadings=wndActive.RowHeadings

'SettheheadingsofcolumnsAthroughD.hdrColHeadings(1).Caption="Qtr1"hdrColHeadings(2).Caption="Qtr2"hdrColHeadings(3).Caption="Qtr3"hdrColHeadings(4).Caption="Qtr4"

'Settheheadingsofrows1though5.hdrRowHeadings(1).Caption="1996"hdrRowHeadings(2).Caption="1997"hdrRowHeadings(3).Caption="1998"hdrRowHeadings(4).Caption="1999"hdrRowHeadings(5).Caption="2000"EndSub

RowHeightProperty

Returnsorsetstheheight(inpoints)ofallrowsinthespecifiedrange.ReturnsNulliftherowsarenotallthesameheight.UsetheIsNullfunctiontodeterminewhetherthereturnvalueisNull.Read/writeVariant.

expression.RowHeight

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplesetstherowheightto15pointsforrows1through10.

Spreadsheet1.Range("a1:a10").RowHeight=15

RowMemberProperty

ReturnsaPivotRowMemberobjectthatrepresentstheinnermemberontherowaxisthatintersectsthespecifiedcell.

expression.RowMember

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RowMembersProperty

ReturnsaPivotRowMemberscollectionthatcontainsthemembersontherowaxis.

expression.RowMembers

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

RowsProperty

Rangeobject:ReturnsaRangeobjectthatrepresentsalltherowsinthespecifiedrange.

Spreadsheetobject:ReturnsaRangeobjectthatrepresentsalltherowsontheactiveworksheet.

Worksheetobject:ReturnsaRangeobjectthatrepresentsalltherowsonthespecifiedworksheet.

expression.Rows

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplemakeseveryotherrowboldinthecurrentregionforcellA1.

SubBoldEvenRows()

DimrngCurrentRow

'Loopthroughtherowsinthecurrentregion.ForEachrngCurrentRowInSpreadsheet1.Cells(1,1).CurrentRegion.

'Checkwhentherthecurrentrownumberisanevennumber.IfrngCurrentRow.RowMod2=0Then

'Boldthefontinthecurrentrow.rngCurrentRow.Font.Bold=TrueEndIfNextEndSub

Thisexamplemakesrow2bold.

Spreadsheet1.Rows(2).Font.Bold=True

ScalingProperty

ReturnstheChScalingobjectforthespecifiedaxis.

expression.Scaling

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleaddsasecondvalue(y)axistotherightsideofthespecifiedchart.Thesecondaxisusesthesamescaleastheprimaryvalueaxis.

SubAddAxis()

DimchConstantsDimaxisScale

SetchConstants=ChartSpace1.Constants

SetaxisScale=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionLeft).

ChartSpace1.Charts(0).Axes.AddaxisScale

EndSub

ShowAll

ScalingsProperty

ReturnsaChScalingobjectforthespecifiedchartorseries.

expression.Scalings(Dimension)

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

DimensionRequiredChartDimensionsEnum.Specifiesthedimensiontobereturned.

ExampleThisexamplesetstheminimumvalueforthespecifiedChScalingobject.

SubSetScaling()

DimchConstants

SetchConstants=ChartSpace1.Constants

ChartSpace1.Charts(0).SeriesCollection(0).Scalings_(chConstants.chDimCategories).Minimum=-10EndSub

SchemaFieldsProperty

ReturnstheSchemaFieldscollectionforthespecifiedschemarowsource.

expression.SchemaFields

expressionRequired.AnexpressionthatreturnsaSchemaRowsourceobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

SchemaParametersProperty

ReturnstheSchemaParameterscollectionforthespecifiedschemarowsource.

expression.SchemaParameters

expressionRequired.AnexpressionthatreturnsaSchemaRowsourceobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

SchemaRelatedFieldsProperty

ReturnstheSchemaRelatedFieldscollectionforthespecifiedschemarelationship.

expression.SchemaRelatedFields

expressionRequired.AnexpressionthatreturnsaSchemaRelationshipobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

SchemaRelationshipsProperty

ReturnstheSchemaRelationshipscollectionforthedatasourcecontrol.

expression.SchemaRelationships

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

SchemaRowsourcesProperty

ReturnstheSchemaRowsourcescollectionforthedatasourcecontrol.

expression.SchemaRowsources

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RemarksIndesignmode,thiscollectionisautomaticallypopulatedwithinformationfromthedatabase.Inbrowsemode,thiscollectioncontainsanyschemaobjectsthatareusedonthespecifiedpage,plusanythatareexplicitlyaddedbytheuser.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ScreenUpdatingProperty

Trueifscreenupdatingisturnedon.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ScreenUpdating

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksSettingthispropertytoFalsecausesthechartworkspaceorspreadsheettostopredrawing.Topreventscreenflickerortopreventtheuserfromseeingindividualupdates,setthispropertytoFalse,performyourupdateoperations,andthenresetthispropertytoTrue.AftersettingtheScreenUpdatingpropertytoFalse,thechartworkspaceorspreadsheetwillstillredrawiftheuserrefreshesthepage,andiftheRepaintmethodiscalledonthecontrol.

ExampleThisexampleturnsoffscreenupdating.

Spreadsheet1.ScreenUpdating=False

ScrollColumnProperty

Returnsorsetsthenumberoftheleftmostcolumninthepaneorwindow.Ifthepanesarefrozen,thispropertyexcludesthefrozenareas.Read/writeLong.

expression.ScrollColumn

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplemovescolumnCsothatit'stheleftmostcolumninthewindow.

Spreadsheet1.ActiveWindow.ScrollColumn=3

ScrollRowProperty

Returnsorsetsthenumberoftherowthatappearsatthetopofthepaneorwindow.Ifthepanesarefrozen,thispropertyexcludesthefrozenareas.Read/writeLong.

expression.ScrollRow

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplemovesrowtentothetopofthewindow.

Spreadsheet1.ActiveWindow.ScrollRow=10

ScrollViewProperty

YouusetheScrollViewpropertytoreturntheChScrollViewobjectforachart.Read-onlyChScrollView.

expression.ScrollView

expressionRequired.AnexpressionthatreturnsaChChartobject.

Remarks

TheChartSpaceobjectsupportsmultiplechartsandeachiscanbescrolledindependently.ThereisoneChScrollViewobjectperchart.YouusethepropertiesandmethodsoftheChScrollViewobjecttoretrieveinformationaboutandcontrolthescrollviewofachart.

ExampleThefollowingexampleusestheScrollViewpropertytoworkwiththeSetPositionmethodoftheChScrollViewobject:

Chartspace1.Charts(1).ScrollView.SetPosition(HorizontalPosition.Value+200,VerticalPosition.Value+200)

SectionProperty

ReturnsaSectionobjectthatrepresentsthesectionwherethespecifiedeventoccurred.

expression.Section

expressionRequired.AnexpressionthatreturnsaDSCEventInfoobject.

SegmentsProperty

ReturnsaChSegmentsobjectthatrepresentsthecollectionofsegmentsinthespecifiedformatmap.

expression.Segments

expressionRequired.AnexpressionthatreturnsaChFormatMapobject.

ExampleThisexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreated.Thesmallervaluesaredisplayedinwhite,thenlargervaluesaredisplayedinalightshadeofblue,andfinallythelargervaluesinthechartaredisplayedwithindarkblue.

SubWindow_Onload()

DimserSeries1DimsegSegment1Dimchconstants

Setchconstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;persistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=DataServer;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderDetailstable.ChartSpace1.SetDatachconstants.chDimCategories,chconstants.chDataBound,"ProductID"ChartSpace1.SetDatachconstants.chDimValues,chconstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachconstants.chDimFormatValues,chconstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.SetsegSegment1=serSeries1.FormatMap.Segments.Add

'Specifythatthedivisionsinformattingbecreatedautomatically.segSegment1.HasAutoDivisions=True

'Measurethesegmentboundariesbaseduponapercentage.segSegment1.Begin.ValueType=chconstants.chBoundaryValuePercentsegSegment1.End.ValueType=chconstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto100%.segSegment1.Begin.Value=0segSegment1.End.Value=1

'Formattheinteriorofthematchingvalues.segSegment1.Begin.Interior.Color="White"segSegment1.End.Interior.Color="Blue"

EndSub

SelectedSheetsProperty

ReturnsaSheetscollectionthatrepresentsalltheselectedsheetsinthespecifiedwindow.Thiscollectionwillonlycontainonesheet,theactivesheet.

expression.SelectedSheets

expressionRequired.AnexpressionthatreturnsaWindowobject.

SelectionProperty

ChartSpaceobject:ReturnsanObjectthatrepresentstheselectedobject.UsetheTypeNamefunctiontodeterminethetypeoftheselectedobject.

PivotTableobject:ReturnsorsetsanObjectthatrepresentstheselectedobject.

SpreadsheetandWindowobjects:ReturnsaRangeobjectthatrepresentstheselectedcells.

expression.Selection

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleTheprocedureinthisexamplerunswhenevertheselectioninthechartworkspacechanges.Iftheuserselectsanaxis,theproceduredisplaystheminimumandmaximumvaluesfortheaxis.

SubChartSpace1_SelectionChange()

DimchConstantsDimminvalDimmaxval

SetchConstants=ChartSpace1.Constants

IfChartSpace1.SelectionType=chConstants.chSelectionAxisThen

minval=ChartSpace1.Selection.Scaling.Minimum

maxval=ChartSpace1.Selection.Scaling.Maximum

MsgBox"minimum="&minval&"maximum="&maxvalEndIf

EndSub

SelectionCollectionProperty

TheSelectionCollectionpropertytoreturnstheChSelectionCollectioncollectionoftheChartSpaceobject.

expression.SelectionCollection

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksTheChSelectionCollectionobjectcontainsallcurrentlyselectedobjectsinachart.Thefirstiteminthecollectionistheprimaryselection.Additionalitemsaresecondaryselections.ThenumberofitemsinthiscollectioncanneverbezerobecausetheobjectreturnedbyChartSpace.SelectionCollection(0)isthesameobjectasthatreturnedbytheSelectionpropertyoftheChartSpaceobject.Thefirstobjectinthecollectioncanbeanychartobjectselection,butallsubsequentobjectsmustbepoints.IftheSelectionpropertyisnullandtherearenosecondaryselections,theSelectionCollectionwillequal0.

MultipleitemscannotbeselectedintheuserinterfaceoftheChartcomponent.Itemsmustbeaddedtoorremovedfromaselectionprogrammatically.Tocapturemultipleselectionswhenauserclicksonachart,youmustmonitorthemousemoveandmousebuttoneventsandidentifytheitemsbeingselectedusingtheRangeFromPointmethodoftheChartSpaceobject.Topreventthebuilt-inselectionhandlingbehavioroftheChartcomponentfrominterferingwithprogrammatictrackingofmultipleselections,youmustmakesurethattheAllowUISelectionpropertyoftheChartSpaceobjectissettoFalse.

ExampleThefollowingexampleshowshowtousetheSelectionCollectionpropertytoiteratethroughasetofselecteddatapointsinachart.

DimintCountDimintIndexWithChartSpace.Charts(0).SeriesCollection(0).Points(0).Select21.Points(1).Select21.Points(2).Select21.Points(3).Select21.Points(4).Select21EndWithintCount=ChartSpace.SelectionCollection.Count

ForintIndex=0TointCount-1MsgBox"Item("&iIndex&")="&TypeName(ChartSpace.SelectionCollectionNext

ShowAll

SelectionTypeProperty

ChartSpaceobject:ReturnsaChartSelectionsEnumconstantthatrepresentsthetypeofobjectcurrentlyselectedinthechartworkspace.Read-only.

PivotTableobject:ReturnsaStringthatrepresentsthetypeofobjectcurrentlyselectedinthePivotTablelist.Read-only.

expression.SelectionType

expressionRequired.AnexpressionthatreturnsaChartSpaceorPivotTableobject.

ExampleTheprocedureinthisexamplerunswhenevertheselectioninthechartworkspacechanges.Iftheuserselectsanaxis,theproceduredisplaystheminimumandmaximumvaluesfortheaxis.

SubChartSpace1_SelectionChange()

DimchConstantsDimminvalDimmaxval

SetchConstants=ChartSpace1.Constants

IfChartSpace1.SelectionType=chConstants.chSelectionAxisThen

minval=ChartSpace1.Selection.Scaling.Minimum

maxval=ChartSpace1.Selection.Scaling.Maximum

MsgBox"minimum="&minval&"maximum="&maxvalEndIf

EndSub

SeparatorProperty

Returnsorsetsthestringthatseparatesdatalabelcomponentsinthespecifiedseriesorchart.Read/writeString.

expression.Separator

expressionRequired.AnexpressionthatreturnsaChDataLabelsobject.

ExampleThisexamplechangesthedata-labelseparatorcharacterforthespecifiedseries.

SubFormatDataLabels()

DimdlDataLabels

'Adddatalabelstothefirstseries.SetdlDataLabels=ChartSpace1.Charts(0).SeriesCollection(0)_.DataLabelsCollection.Add

'Displaythecategorynameinthedatalabels.dlDataLabels.HasCategoryName=True

'Setthedatalabelseperator.dlDataLabels.Separator=":"

EndSub

SeriesCollectionProperty

ReturnstheChSeriesCollectioncollectionforthespecifiedchart.

expression.SeriesCollection

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ExampleThisexamplesetsthelinecolortoredforthespecifiedseries.

ChartSpace1.Charts(0).SeriesCollection(0).Line.Color="red"

ServerFilterProperty

Returnsorsetstheserverfilterforthespecifiedobject.Read/writeString.

expression.ServerFilter

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksAserverfilterisacriterionforspecifyingthetypeortypesofrecordstobefetchedfromtheserver.ThedatamodeladdsaserverfilterstringtotheWHEREclauseoftheSQLstatementthatitgenerates.YoucansetaserverfilteronlyonrecordsetsthathaveaprimaryrowsourceoftypedscTableordscView.

ShowAll

SheetsProperty

SheetspropertyasitappliestotheSpreadsheetobject.

SheetspropertyasitappliestotheWorkbookobject.

ExampleAsitappliestotheWorkbookobject.

ShowAllProperty

ClearsAutoFiltercriteriawhensettoTrue.AddingcriteriasetsthispropertytoFalse.IftherearenocriteriaandthispropertyissettoFalse,nodatawillbeshown.Read/writeBoolean.

expression.ShowAll

expressionRequired.AnexpressionthatreturnsaCriteriaobject.

ExampleThisexampleclearstheAutoFiltercriteriaforcolumn1ontheactiveworksheetandreappliestheAutoFiltertotheworksheet.

SubReapplyAutoFilter()

DimafAutoFilter

'Setavariabletothecurrentfiltersettings.SetafAutoFilter=Spreadsheet1.ActiveSheet.AutoFilter

'Showallrecords.afAutoFilter.Filters(1).Criteria.ShowAll=True

'Reapplythefilters.afAutoFilter.Apply

EndSub

ShowAll

ShowAsProperty

ReturnsorsetsaPivotShowAsEnumconstantthatrepresentshowaPivotTotalobjectisdisplayed.Read-write.

expression.ShowAs

expressionRequired.AnexpressionthatreturnsaPivotTotalobject.

ExampleThisexampleaddsanewtotaltoPivotTable1.Thenewtotalisformattedtodisplayasapercentageoftheparentrowfield,andwillnotappearinthePivotTableFieldListdialogbox.

SubAdd_Total()

DimvwViewDimptConstantsDimtotNewTotal

SetvwView=PivotTable1.ActiveViewSetptConstants=PivotTable1.Constants

'Addanewtotalnamed"TotalBudget"tothecurrentview.SettotNewTotal=vwView.AddTotal("TotalBudget",vwView.FieldSets("Budget").Fields(0),_ptConstants.plFunctionSum)

'InsertthenewlycreatedtotalintothedetailareaofthePivotTable.vwView.DataAxis.InsertTotaltotNewTotal

'Showthetotalsasapercentageoftheparentrowfield.totNewTotal.ShowAs=ptConstants.plShowAsPercentOfRowParent

'DonotdisplaythenewtotalinthePivotTableFieldListdialogbox.totNewTotal.DisplayInFieldList=False

EndSub

ShowAsValueProperty

ReturnsaVariantthatrepresentsthevalueofthespecifiedPivotAggregateobjectwithoutpercentageformatting.Usethispropertytoreturnthevalueofacell'saggregatewhentheShowAspropertyhasbeensettooneofthefollowingvalues:plShowAsPercentOfColumnParent,plShowAsPercentOfColumnTotal,plShowAsPercentOfGrandTotal,plShowAsPercentOfRowParent,plShowAsPercentOfRowTotal.Read-only.

expression.ShowAsValue

expressionRequired.AnexpressionthatreturnsaPivotAggregateobject.

ExampleThisexampledisplaystheaggregateforthethirdmemberoftherowfieldinamessagebox.

SubGetTotal()

DimptDataDimpmRowMemDimpmColMem

'SetavariabletothePivotTabledata.SetptData=PivotTable1.ActiveData

'Setavariabletothethirditemcontainedinthefield'thathasbeenaddedtotherowaxis.SetpmRowMem=ptData.RowAxis.Member.ChildMembers(2)

'Inthisexample,therearenofieldsonthecolumnaxis.SetpmColMem=ptData.ColumnAxis.Member

'Displaythevalueoftheaggregate.MsgBoxptData.Cells(pmRowMem,pmColMem).Aggregates(0).ShowAsValue

EndSub

ShowDelButtonProperty

TrueiftheDeletebutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowDelButton

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ShowFilterBySelectionButtonProperty

TrueiftheFilterbySelectionbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowFilterBySelectionButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowFirstButtonProperty

TrueiftheFirstbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowFirstButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowHelpButtonProperty

TrueiftheHelpbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowHelpButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowLabelProperty

Trueiftherecordnavigationcontrollabelisdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowLabel

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowLastButtonProperty

TrueiftheLastbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowLastButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowNewButtonProperty

TrueiftheNewbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowNewButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowNextButtonProperty

TrueiftheNextbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowNextButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowPrevButtonProperty

TrueifthePreviousbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowPrevButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowSaveButtonProperty

TrueiftheSavebutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowSaveButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowSortAscendingButtonProperty

TrueiftheSortAscendingbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowSortAscendingButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowSortDescendingButtonProperty

TrueiftheSortDescendingbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowSortDescendingButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowToggleFilterButtonProperty

TrueiftheToggleFilterbutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowToggleFilterButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

ShowUndoButtonProperty

TrueiftheUndobutton(recordnavigationcontrol)isdisplayed.ThedefaultvalueisTrue.Read/writeBoolean.

expression.ShowUndoButton

expressionRequired.AnexpressionthatreturnsaRecordNavigationControlobject.

SideWallProperty

ReturnsaChSurfaceobjectthatrepresentsthesidewallofathree-dimensionalchart.UsethepropertiesandmethodsofthereturnedChSurfaceobjecttoformatthesidewallofthespecifiedchart.

expression.SideWall

expressionRequired.AnexpressionthatreturnsaChPlotAreaobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DColumnchartandthenformatsthebackwall,sidewall,andfloorofthechart.

SubFormatWallsFloor()

Dimcht3DColumnDimchConstantsDimpaPlotArea

SetchConstants=Chartspace1.Constants

'SetavariabletothefirstchartinChartspace1.Setcht3DColumn=ChartSpace1.Charts(0)

'Setavariabletotheplotarea.SetpaPlotArea=cht3DColumn.PlotArea

'Changethecharttoa3DColumnchart.cht3DColumn.Type=chConstants.chChartTypeColumnClustered3D

'Formatthebackwallofthechart.paPlotArea.BackWall.Interior.SetSolid"Yellow"paPlotArea.BackWall.Thickness=5

'Formatthesidewallofthechart.paPlotArea.SideWall.Interior.SetSolid"Yellow"paPlotArea.SideWall.Thickness=5

'Formatthefloorofthechart.paPlotArea.Floor.Interior.SetSolid"Blue"

paPlotArea.Floor.Thickness=5

EndSub

SizeProperty

Returnsorsetsthefontormarkersize(inpoints).ReturnsNullifitisusedonarangeinwhichthecharactersarenotallthesamesize.UsetheIsNullfunctiontodeterminewhetherthereturnvalueisNull.Read/writeVariantfortheFontobject;read/writeLongforallotherobjectsintheAppliesTolist.

expression.Size

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsthefontsizeto6pointsforthespecifiedaxis.

Setc=ChartSpace1.ConstantsChartSpace1.Charts(0).Axes(c.chAxisPositionLeft).Font.Size=6

ShowAll

SizeRepresentsProperty

Returnsorsetswhatthebubblesizerepresentsonabubblechart.Read/writeChartSizeRepresentsEnum.

expression.SizeRepresents

expressionRequired.AnexpressionthatreturnsaChChartobject.

ExampleThisexamplesetstheSizeRepresentspropertyforabubblechart.

SubSetSizeParameter()

DimchConstants

SetchConstants=Chartspace1.Constants

ChartSpace1.Charts(0).SizeRepresents=chConstants.chSizeIsArea

EndSub

SolveOrderProperty

ReturnsorsetsaLongthatrepresentsthesolveorderforthespecifiedtotal.Read/write.

expression.SolveOrder

expressionRequired.AnexpressionthatreturnsaPivotTotalobject.

ShowAll

SortDirectionProperty

Returnsorsetsthedirectioninwhichthespecifiedfieldistobesorted.Read/writePivotFieldSortDirectionEnum.

expression.SortDirection

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksThefieldissortedbasedonthesortingrulesoftheunderlyingdataprovider.Forexample,adataprovidermightsortdatesalphanumerically(February,January,andsoon)orinachronologicalmonthlysequence(January,February,andsoon)

SortOnProperty

Returnsorsetsthetotalusedtosortthespecifiedfield.Read/writePivotTotal.

expression.SortOn

expressionRequired.AnexpressionthatreturnsaPivotFieldobject..

SortOnScopeProperty

Returnsorsetsthearrayofstringsusedtonarrowthesortingscopeforthespecifiedfield.Read/writeVariant.

expression.SortOnScope

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

SourceProperty

Returnsorsetsthesourceforthespecifiedpagefieldorpagerowsource.Read/writeString.

expression.Source

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

SourceAxisProperty

ReturnsaPivotAxisobjectthatrepresentsthesourceaxisofthespecifiedresultaxis.

expression.SourceAxis

expressionRequired.AnexpressionthatreturnsaPivotResultAxisobject.

SourceColumnAxisProperty

ReturnsaPivotGroupAxisobjectthatrepresentsthesourceaxisofthespecifiedresultaxis.

expression.SourceColumnAxis

expressionRequired.AnexpressionthatreturnsaPivotResultColumnAxisobject.

SourceDataAxisProperty

ReturnsaPivotDataAxisobjectthatrepresentsthesourceaxisofthespecifiedresultaxis.

expression.SourceDataAxis

expressionRequired.AnexpressionthatreturnsaPivotResultDataAxisobject.

SourceFieldProperty

ReturnsaPivotFieldobjectthatrepresentsthesourcefieldforthespecifiedresultfield.

expression.SourceField

expressionRequired.AnexpressionthatreturnsaPivotResultFieldobject.

SourceFilterAxisProperty

ReturnsaPivotFilterAxisobjectthatrepresentsthesourceaxisofthespecifiedresultaxis.

expression.SourceFilterAxis

expressionRequired.AnexpressionthatreturnsaPivotResultFilterAxisobject.

SourceLabelProperty

ReturnsaPivotLabelobjectthatrepresentsthesourcelabelofthespecifiedresultlabel.

expression.SourceLabel

expressionRequired.AnexpressionthatreturnsaPivotResultLabelobject.

SourceMemberProperty

ReturnsaPivotMemberobjectthatrepresentsthesourcememberforthespecifiedaxismember.

expression.SourceMember

expressionRequired.AnexpressionthatreturnsaPivotAxisMemberobject.

SourcePageAxisProperty

ReturnsaPivotGroupAxisobjectthatrepresentsthesourceaxisofthespecifiedresultaxis.

expression.SourcePageAxis

expressionRequired.AnexpressionthatreturnsaPivotResultPageAxisobject.

SourceRowAxisProperty

ReturnsaPivotGroupAxisobjectthatrepresentsthesourceaxisforthespecifiedresultaxis.

expression.SourceRowAxis

expressionRequired.AnexpressionthatreturnsaPivotResultRowAxisproperty.

SplitMaximumProperty

IfthespecifiedChScalingobjecthasasplit,thispropertyreturnsorsetsthemaximumvalueforthesplit.ThisvalueshouldbegreaterthanthevalueoftheSplitMinimumproperty.Read/writeDouble.

expression.SplitMaximum

expressionRequired.AnexpressionthatreturnsaChScalingobject.

ExampleThisexamplesplitsthevalueaxisofthefirstchartinChartSpace1andsetsthesplitminimumandsplitmaximumvalues.Thevalueaxisissplit,andvaluesbetween1000and5000willnotbedisplayed.

SubSplit_Value_Axis()DimchConstantsDimscValueAxisSetchConstants=ChartSpace1.Constants'Setavariabletothescalingobjectofthevalueaxis.SetscValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).Scaling'Addasplittothevalueaxis.scValueAxis.HasSplit=True'Specifytheminnimumvalueofthesplit.scValueAxis.SplitMinimum=1000'Specifythemaximumvalueforthesplit.scValueAxis.SplitMaximum=5000EndSub

SplitMinimumProperty

IfthespecifiedChScalingobjecthasasplit,thispropertyreturnsorsetstheminimumvalueforthesplit.ThisvalueshouldbelessthanthevalueoftheSplitMaximumproperty.Read/writeDouble.

expression.SplitMinimum

expressionRequired.AnexpressionthatreturnsaChScalingobject.

ExampleThisexamplesplitsthevalueaxisofthefirstchartinChartSpace1andsetsthesplitminimumandsplitmaximumvalues.Thevalueaxisissplit,andvaluesbetween1000and5000willnotbedisplayed.

SubSplit_Value_Axis()DimchConstantsDimscValueAxisSetchConstants=ChartSpace1.Constants'Setavariabletothescalingobjectofthevalueaxis.SetscValueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).Scaling'Addasplittothevalueaxis.scValueAxis.HasSplit=True'Specifytheminnimumvalueofthesplit.scValueAxis.SplitMinimum=1000'Specifythemaximumvalueforthesplit.scValueAxis.SplitMaximum=5000EndSub

StandardHeightProperty

Returnsthestandard(default)heightofalltherowsintheworksheetinpoints.Read-onlyDouble.

expression.StandardHeight

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

ExampleThisexampleresetstherowsandcolumnsintheactivesheetofSpreadsheet1totheirdefaultsize.

SubReset_Height_Width()DimshtActiveSetshtActive=Spreadsheet1.ActiveSheet

shtActive.Rows.RowHeight=shtActive.StandardHeightshtActive.Columns.ColumnWidth=shtActive.StandardWidthEndSub

StandardWidthProperty

Returnsthestandard(default)widthofallthecolumnsintheworksheet.ThewidthofonecharacterintheNormalstyleisusedastheunitofmeasure.Read/writeDouble.

expression.StandardWidth

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

ExampleThisexampleresetstherowsandcolumnsintheactivesheetofSpreadsheet1totheirdefaultsize.

SubReset_Height_Width()DimshtActiveSetshtActive=Spreadsheet1.ActiveSheet

shtActive.Rows.RowHeight=shtActive.StandardHeightshtActive.Columns.ColumnWidth=shtActive.StandardWidthEndSub

ShowAll

StatusProperty

ReturnsaDscStatusEnumconstantthatrepresentsthestatusofthecurrentevent.ThispropertyissupportedonlyintheAfterDeleteevent.Read-only.

expression.Status

expressionRequired.AnexpressionthatreturnsaDSCEventInfoobject.

RemarksUsingthispropertywithanunsupportedeventwillresultinarun-timeerror.

ShowAll

StyleProperty

Returnsorsetsthemarkerstyleforthespecifiedseriesorchart.Read/writeChartMarkerStyleEnum.

expression.Style

expressionRequired.AnexpressionthatreturnsaChMarkerobject.

ExampleThisexamplesetsthemarkerstyleforthespecifiedseries.

SubSetMarkerStyle()

DimchConstants

SetchConstants=ChartSpace1.Constants

ChartSpace1.Charts(0).SeriesCollection(0).Marker_.Style=chConstants.chMarkerStyleStar

EndSub

SublistRelationshipsProperty

ReturnstheSublistRelationshipscollectionforthespecifiedrecordsetdefinition.

expression.SublistRelationships

expressionRequired.AnexpressionthatreturnsaRecordsetDefobject.

RemarksAsublistrelationshipreferstoarowsourceinanotherrecordsetdefinitionthathasamany-to-onerelationshipwiththeprimarypagerowsourceinthespecifiedrecordsetdefinition.

Forinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

SublistSchemaRelationshipsProperty

ReturnstheSublistSchemaRelationshipscollectionforthespecifiedschemarowsource.

expression.SublistSchemaRelationships

expressionRequired.AnexpressionthatreturnsaSchemaRowsourceobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

SubtotalBackColorProperty

Returnsorsetsthebackcolorforthesubtotalinthespecifiedfield.Forsubtotals,thisproperty’ssettingoverridestheTotalBackColorpropertysetting.Read/writeVariant.

expression.SubtotalBackColor

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

SubtotalFontProperty

ReturnsaPivotFontobjectthatrepresentsthefontforsubtotals.

expression.SubtotalFont

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

SubtotalForeColorProperty

Returnsorsetstheforegroundcolorforsubtotalsinthespecifiedfield.Thisproperty’ssettingoverridestheTotalForeColorpropertysetting.Read/writeVariant.

expression.SubtotalForeColor

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

SubtotalLabelBackColorProperty

Returnsorsetsthebackcolorforthesubtotalinthespecifiedfield.Read/writeVariant.

expression.SubtotalLabelBackColor

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

SubtotalLabelFontProperty

ReturnsaPivotFontobjectthatrepresentsthefontforsubtotallabelsinthespecifiedfield.

expression.SubtotalLabelFont

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

SubtotalLabelForeColorProperty

Returnsorsetstheforegroundcolorforsubtotallabelsinthespecifiedfield.Read/writeVariant.

expression.SubtotalLabelForeColor

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

ShowAll

SubtotalLabelHAlignmentProperty

ReturnsorsetsaPivotHAlignmentEnumconstantthatrepresentsthehorizontalalignmentofthesubtotallabelsforthespecifiedfield.Read/write.

expression.SubtotalLabelHAlignment

expressionRequired.AnexpressionthatreturnsaPivotFieldobject.

SubtotalsProperty

Trueifthesubtotalisdisplayedforthespecifiedfield.Read/writeBoolean.

expression.Subtotals(Subtotals)

expressionAnexpressionthatreturnsaPivotFieldobject.Thefieldmustbeonaroworcolumnaxis.

SubtotalsRequiredLong.Specifiesthesubtotal.

TabRatioProperty

Returnsorsetstheratioofthewidthoftheworkbook'stabareatothewidthofthewindow'shorizontalscrollbar(asanumberbetween0(zero)and1;thedefaultvalueis0.6).Changingthevalueofthispropertyhasaninverseeffectonthelengthofthewindow'shorizontalscrollbar.Increasingthispropertyfromthedefaultvaluedecreasesthelengthofthescrollbar,whiledecreasingthispropertyfromthedefaultvalueincreasesthelengthofthescrollbar.Read/writeDouble.

expression.TabRatio

expressionRequired.AnexpressionthatreturnsaWindowobject.

ExampleThisexamplemakestheworkbooktabhalfthewidthofthehorizontalscrollbar.

Spreadsheet1.ActiveWindow.TabRatio=0.5

ShowAll

TextProperty

TextpropertyasitappliestothePivotAggregateandPivotDetailCellobjects.

TextpropertyasitappliestotheRangeobject.

ExampleThisexamplesetsavariablefortheformattedvalueofcellA1.

txt=Spreadsheet1.Range("a1").Text

ShowAll

TextureFormatProperty

ReturnsaChartTextureFormatEnumconstantindicatingtheformatusedtodisplaythetextureforthespecifiedChInteriorobject.Thispropertywillreturnarun-timeerrorifthespecifiedinteriorisnotfilledwithatextureorapicture.Read-only.

expression.TextureFormat

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

TextureNameProperty

ReturnsaStringindicatingthenameofandpathtothepicturefilethatwasusedtofillthespecifiedChInteriorobject.Thispropertywillreturnarun-timeerroriftheinteriorofthespecifiedobjectwassettoapresettexture.Read-only.

expression.TextureName

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksUsetheSetTexturedmethodtosetthetexturefileforthefill.

ShowAll

TexturePlacementProperty

ReturnsaChartTexturePlacementEnumconstantindicatinghowthetexturehasbeenappliedtothespecifiedChInteriorobject.Read-only.

expression.TexturePlacement

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

RemarksThispropertyonlyaffects3-Dcharts.

TextureStackUnitProperty

ReturnsaDoubleindicatingthetexturestackunitforthespecifiedChInteriorobject.Thispropertywillreturnarun-timeerrorunlesstheSetTexturemethodwasusedtofilltheinterioroftheobjectandthemethod'sTextureFormatargumentissettoavalueofchStackScale.Read-only.

expression.TextureStackUnit

expressionRequired.AnexpressionthatreturnsaChInteriorobject.

ThicknessProperty

ReturnsorsetsaLongspecifyingthethicknessofthespecifieddataseriesorsurfaceinathree-dimensionalchart.Read/write.

expression.Thickness

expressionRequired.AnexpressionthatreturnsaChSeriesoraChSurfaceobject.

RemarksUsethispropertytosetthethicknessofalineina3-DLinechartorthethicknessofthepieina3-DPiechart.

ExampleThisexampleconvertsthefirstchartinChartspace1toa3-DLinechartandthensetsthethicknessforeachlineinthechart.

SubSetLineThickness()

Dimcht3DLineDimserSeries

'SetavariabletothefirstchartinChartspace1.Setcht3DLine=ChartSpace1.Charts(0)

'Changethecharttoa3DLinechart.cht3DLine.Type=chChartTypeLine3D

'Setthethicknessofeachlineinthechart.ForEachserSeriesIncht3DLine.SeriesCollectionserSeries.Thickness=4NextEndSub

TickLabelSpacingProperty

Returnsorsetsthenumberofcategoriesbetweentick-marklabelsforthespecifiedaxis.Appliesonlytocategoryaxes.Read/writeLong.

expression.TickLabelSpacing

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetsthenumberofcategoriesbetweentick-marklabelsforthespecifiedaxistotwo.

ChartSpace1.Charts(0).Axes(1).TickLabelSpacing=2

ShowAll

TickLabelUnitTypeProperty

ReturnsorsetsaChartAxisUnitTypeEnumconstantthatrepresentstheintervalusedtodisplaytickmarklabelsonatime-scaledcategoryaxis.Read/write.

expression.TickLabelUnitType

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toalinechart,thenformatsthecategoryaxissothatthevaluesaregroupedbymonth.Theaveragevalueofeachmonthisdisplayedonthechart.

SubFormatTimeScaling()

DimchConstantsDimaxCategory

SetchConstants=ChartSpace1.Constants

'ChangethecharttoaLinechart.ChartSpace1.Charts(0).Type=chConstants.chChartTypeLine

'Setavariabletothecategoryaxis.SetaxCategory=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory)

'Specifythatyouwilldeterminethegroupingsettingsofthe'axis.Notethatthislineofcodeisnecessaryonlyifthe'GroupingTypepropertyfortheaxishasbeenpreviouslysetto'chAxisGroupingNone.axCategory.GroupingType=chConstants.chAxisGroupingManual

'Groupthecategoryaxisbymonth.axCategory.GroupingUnitType=chConstants.chAxisUnitMonth

'Createanewgroupingforeverymonth.axCategory.GroupingUnit=1

'Displaytheaverageoftheitemsineachgroup.

axCategory.GroupingTotalFunction=chConstants.chFunctionAvg

'Aticklabelisdisplayedforeverymonth.axCategory.TickLabelUnitType=chConstants.chAxisUnitMonth

'Atickmarkisdisplayedforeverythreemonths.axCategory.TickMarkUnitType=chConstants.chAxisUnitQuarter

EndSub

TickMarkSpacingProperty

Returnsorsetsthenumberofcategoriesbetweentickmarksonthespecifiedaxis.Appliesonlytocategoryaxes.UsetheMajorUnitandMinorUnitpropertiestosettick-markspacingonvalueaxes.Read/writeLong.

expression.TickMarkSpacing

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexamplesetsthenumberofcategoriesbetweentickmarksonthespecifiedaxistotwo.

ChartSpace1.Charts(0).Axes(1).TickMarkSpacing=2

ShowAll

TickMarkUnitTypeProperty

ReturnsorsetsaChartAxisUnitTypeEnumconstantthatrepresentstheintervalusedtodisplaytickmarksonatime-scaledcategoryaxis.Read/write.

expression.TickMarkUnitType

expressionRequired.AnexpressionthatreturnsaChAxisobject.

ExampleThisexampleconvertsthefirstchartinChartspace1toalinechart,thenformatsthecategoryaxissothatthevaluesaregroupedbymonth.Theaveragevalueofeachmonthisdisplayedonthechart.

SubFormatTimeScaling()

DimchConstantsDimaxCategory

SetchConstants=ChartSpace1.Constants

'ChangethecharttoaLinechart.ChartSpace1.Charts(0).Type=chConstants.chChartTypeLine

'Setavariabletothecategoryaxis.SetaxCategory=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionCategory)

'Specifythatyouwilldeterminethegroupingsettingsofthe'axis.Notethatthislineofcodeisnecessaryonlyifthe'GroupingTypepropertyfortheaxishasbeenpreviouslysetto'chAxisGroupingNone.axCategory.GroupingType=chConstants.chAxisGroupingManual

'Groupthecategoryaxisbymonth.axCategory.GroupingUnitType=chConstants.chAxisUnitMonth

'Createanewgroupingforeverymonth.axCategory.GroupingUnit=1

'Displaytheaverageoftheitemsineachgroup.

axCategory.GroupingTotalFunction=chConstants.chFunctionAvg

'Aticklabelisdisplayedforeverymonth.axCategory.TickLabelUnitType=chConstants.chAxisUnitMonth

'Atickmarkisdisplayedforeverythreemonths.axCategory.TickMarkUnitType=chConstants.chAxisUnitQuarter

EndSub

TimeValueProperty

ReturnsaVariantthatrepresentsthevalueofthespecifiedmemberwiththeappropriatedateoftimeformat.Read-only.

expression.TimeValue

expressionRequired.AnexpressionthatreturnsaPivotMemberobject.

ShowAll

TipTextProperty

TipTextpropertyasitappliestotheChSeriesobject.

TipTextpropertyasitappliestotheOCCommandobject.

ExampleAsitappliestotheChSeriesobject.

TitleProperty

ReturnsaChTitleobjectthatrepresentsthetitleofthespecifiedaxisorchart.

expression.Title

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetsthespecifiedcharttoincludeatitleandsetsthetitletext.

SubSetChartTitle()

'Enablethecharttitle.ChartSpace1.Charts(0).HasTitle=True

'Setthecharttitle.ChartSpace1.Charts(0).Title.Caption="SatisfactionData"

EndSub

ShowAll

TitleBarProperty

TitleBarpropertyasitappliestothePivotViewobject.

TitleBarpropertyasitappliestotheSpreadsheetobject.

ExampleThisexamplesetsthetitlecaptionforthespreadsheet.

Spreadsheet1.TitleBar.Caption="MonthlySales"

ToolbarProperty

ReturnsanMSComctlLib.Toolbarobjectthatrepresentsthetoolbar.

expression.Toolbar

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksUsethereturnedMSComctlLib.ToolbarobjecttocustomizethetoolbarintheMicrosoftOfficeWebComponents.Youcanaddorremovebuilt-inbuttonsaswellascustombuttons.

ShowAll

TopProperty

ToppropertyasitappliestotheChartSpace,ChCategoryLabel,ChChartField,ChDataLabel,ChDataLabels,ChErrorBars,ChLegendEntry,ChPoint,ChSeries,ChTrendline,PivotAggregate,PivotAxisMember,PivotColumnMember,PivotDetailCell,PivotPageMember,PivotResultAxis,PivotResultColumnAxis,PivotResultDataAxis,PivotResultFilterAxis,PivotResultGroupAxis,PivotResultLabel,PivotResultPageAxis,PivotResultRowAxis,PivotRowMember,andPivotTableobjects.

ToppropertyasitappliestotheChScrollViewobject.

ToppropertyasitappliestothePivotDataobject.

ToppropertyasitappliestotheRangeobject.

ToppropertyasitappliestotheWindowobject.

ExampleThisexamplesetsavariableforthedistancefromthetopofthespreadsheetwindowtocellA35.

t2=Spreadsheet1.Range("A35").Top

Top2Property

ReturnsaLongvaluethatrepresentsthetopofthedataareaofthePivotTablelist.Read-only.

expression.Top2

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

RemarksThispropertywillreturnavalueof1ifthetoolbarisnotdisplayed.

ShowAll

TopLeftProperty

TopLeftpropertyasitappliestothePivotRangeobject.

TopLeftpropertyasitappliestothePivotDetailRangeobject.

TopOffsetProperty

ReturnsorsetsaLongvaluethatrepresentsthenumberofpixelstoscrollthedataareadown.Read/write.

expression.TopOffset

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

RemarksUsetheLeftOffsettoscrollthedataareatotheleft.

ExampleThisexamplescrollsthedataareaofPivotTable1down45pixelsandleft45pixels.

SubScrollDataArea()

DimptData

SetptData=PivotTable1.ActiveData

'Scroll45pixelsdown.ptData.TopOffset=45

'Scrollthedataareatotheleft.ptData.LeftOffset=45

EndSub

TotalProperty

ReturnsaPivotTotalobjectthatrepresentsthetotalforthespecifiedaggregate.

expression.Total

expressionRequired.AnexpressionthatreturnsaPivotAggregateobject.

TotalAllMembersProperty

Trueiffilteredmembersareincludedinsubtotals.IfthispropertyissettoFalse,subtotalsdonotincludemembersthathavebeenfilteredoutoftheview.ThedefaultvalueisFalse.Read/writeBoolean.

expression.TotalAllMembers

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

TotalBackColorProperty

Returnsorsetsthebackgroundcolorforalltotals.Read/writeVariant.

expression.TotalBackColor

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

TotalColumnMemberProperty

ReturnsaPivotColumnMemberobjectthatrepresentsthememberusedtodisplaythegrandtotal..

expression.TotalColumnMember

expressionRequired.AnexpressionthatreturnsaPivotColumnMemberobject.

TotalFontProperty

ReturnsaPivotFontobjectthatrepresentsthefontusedforaggregatesdisplayedinacellorinadetailgridfooter.

expression.TotalFont

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

TotalForeColorProperty

Returnsorsetstheforegroundcolorforalltotals.Read/writeVariant.

expression.TotalForeColor

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

RemarksWhenyousetthisproperty,youcanuseeitheraLongvaluerepresentingared-green-bluecolorvalueoraStringvaluenamingavalidHTMLcolorvalue.Forexample,tosettheobjectcolortored,youcouldusethehexadecimalvalue&HFF,thedecimalvalue255,orthestringvalue"red."InMicrosoftVisualBasic,youcanusetheRGBfunctiontocreateared-green-bluecolorvalue(redisRGB(255,0,0)).ThispropertyalwaysreturnsthecolorasaLongvaluerepresentingared-green-bluecolorvalue.

TotalMemberProperty

ReturnsaPivotAxisMemberobjectthatrepresentsthememberusedtodisplaysubtotals.

expression.TotalMember

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ShowAll

TotalOrientationProperty

Returnsorsetstheorientationusedtodisplaysummarytotalswhenthereismorethanonetotal.Read/writePivotViewTotalOrientationEnum.

expression.TotalOrientation

expressionRequired.AnexpressionthatreturnsaPivotViewobject.

TotalPageMemberProperty

ReturnsaPivotPageMemberobjectthatrepresentsthememberusedtodisplaythegrandtotal.

expression.TotalPageMember

expressionRequired.AnexpressionthatreturnsaPivotPageMemberobject.

TotalRowHeightProperty

ReturnsorsetsaLongvaluethatrepresentstheheightoftherowthatcontainsthesubtotalforthespecifiedmember.Read/write.

expression.TotalRowHeight

expressionRequired.AnexpressionthatreturnsaPivotRowMemberobject.

TotalRowMemberProperty

ReturnsaPivotRowMemberobjectthatrepresentsthememberusedtodisplaythegrandtotal.

expression.TotalRowMember

expressionRequired.AnexpressionthatreturnsaPivotRowMemberobject.

TotalsProperty

PivotDataAxisandPivotResultDataAxisobjects:ReturnsaPivotTotalscollectionthatcontainsallthePivotTotalobjectsonthesummaryaxis.Thetotalsaredisplayedinthesummaryareaforeachcell.

PivotViewobject:ReturnsaPivotTotalscollectionthatcontainsallthetotalsinthecurrentview.

expression.Totals

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ShowAll

TotalTypeProperty

Returnsorsetsthetypeoftotal.Read/writeDscTotalTypeEnum.

expression.TotalType

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksValuesotherthandscNonearevalidonlywithpagefieldsoftypedscGrouping.

ShowAll

TypeProperty

TypepropertyasitappliestotheChAxisobject.

TypepropertyasitappliestotheChChartandChSeriesobjects.

TypepropertyasitappliestotheChErrorBarsobject.

TypepropertyasitappliestotheChScalingobject.

TypepropertyasitappliestotheChTrendlineobject.

TypepropertyasitappliestothePageRelationshipobject.

TypepropertyasitappliestothePivotFieldobject.

TypepropertyasitappliestothePivotFieldSetobject.

TypepropertyasitappliestothePivotTotalobject.

TypepropertyasitappliestotheSchemaRowsourceobject.

TypepropertyasitappliestotheSectionobject.

TypepropertyasitappliestotheWorksheetobject.

TypepropertyasitappliestotheWindowobject.

ExampleThisexamplesetsthecharttypeforthespecifiedchart.

SubSetChartType()

DimchConstants

SetchConstants=ChartSpace1.Constants

ChartSpace1.Charts(0).Type=chConstants.chChartTypeLineMarkers

EndSub

ShowAll

UnderlineProperty

Returnsorsetsthefontunderlinestyleforthespecifiedrange.Read/writeUnderlineStyleEnumfortheChFontandPivotFontobjects;read/writeVariantfortheFontobject(returnsNullifthecharactersinthefontdonotallhavethesameunderlinestyle;otherwise,returnsoneoftheUnderlineStyleEnumconstants).UsetheIsNullfunctiontodeterminewhetherthereturnvalueisNull.

expression.Underline

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampleaddsasingleunderlinetoallcellvaluesinrow1.

SubFormatFont()

DimssConstants

SetssConstants=Spreadsheet1.Constants

Spreadsheet1.Rows(1).Font.Underline=ssConstants.owcUnderlineStyleSingle

EndSub

UniqueNameProperty

Returnstheuniquenameofthespecifiedobject(theuniquememberreferencereturnedbytheprovider).ReturnsNullifthemembersourceisaRecordsetDefobject.Read-onlyString.

expression.UniqueName

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

UniqueTableProperty

Specifiesthenameoftheupdatabletablewhenaformisboundtoamultitablevieworstoredprocedure.Read/writeString.

expression.UniqueTable

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

UsableHeightProperty

Returnsthemaximumheightofthespaceinpixelsthatawindowcanoccupyintheapplicationwindowarea.ReturnsthesamevalueastheHeightproperty.Read-onlyDouble.

expression.UsableHeight

expressionRequired.AnexpressionthatreturnsaWindowobject.

RemarksYoucanusetheUsableWidthpropertytoreturnthemaximumpossiblewidthforawindow.

UsableWidthProperty

Returnsthemaximumwidthofthespaceinpixelsthatawindowcanoccupyintheapplicationwindowarea.ReturnsthesamevalueastheWidthproperty.Read-onlyDouble.

expression.UsableWidth

expressionRequired.AnexpressionthatreturnsaWindowobject.

RemarksUsetheUsableHeightpropertytoreturnthemaximumpossibleheightforawindow.

UsedRangeProperty

ReturnsaRangeobjectthatrepresentstheusedrangeonthespecifiedworksheet.

expression.UsedRange

expressionRequired.AnexpressionthatreturnsaWorksheetobject.

ExampleThisexampleadjuststherowheightandcolumnwidthfortheusedrangeontheactiveworksheettofitthedatacontainedintherange.

SubAutoFitSpreadsheet()

DimrngUsedRange

'Setavariabletotheusedrangeintheactivesheet.SetrngUsedRange=Spreadsheet1.ActiveSheet.UsedRange

'Autofittherows.rngUsedRange.AutoFitRows

'Autofitthecolumns.rngUsedRange.AutoFitColumns

EndSub

UseRemoteProviderProperty

Trueifthedatasourcecontrolisusingaremoteprovider.Read/writeBoolean.

expression.UseRemoteProvider

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksWhenthispropertyissettoTrue,thedatasourcecontrolusestheMicrosoftRemoteDataServicesproviderfordataconnections.YoucanusethispropertyonlywithpagesthatarereadfromaMicrosoftInternetInformationServerusinganHTTPorHTTPSaddress.TheMicrosoftRemoteDataServicesproviderfetchesdatabypassingHTTPorHTTPSrequeststoIIS,whichthenmakesanOLEDBconnectiontothedatabase.

UserModeProperty

ReturnsaBooleanthatindicateswhetherthePivotTablelistisinview-onlymode.Read-only.

expression.UserMode

expressionRequired.AnexpressionthatreturnsaPivotTableobject.

UseStandardHeightProperty

TrueiftherowheightoftheRangeobjectequalsthestandardheightofthesheet.ReturnsNulliftherangecontainsmorethanonerowandsomeoftherowsarestandardheight.ReturnsFalsewhennoneoftherowsarethestandardheight.Read/writeVariant.

expression.UseStandardHeight

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplesetstheheightofrowfouronSheet1inSpreadsheet1tothestandardheight.

Spreadsheet1.Worksheets("Sheet1").Rows(4).UseStandardHeight=True

UseStandardWidthProperty

TrueifthecolumnwidthoftheRangeobjectequalsthestandardwidthofthesheet.ReturnsNulliftherangecontainsmorethanonecolumnandsomeofthecolumnsarestandardwidth.Falsewhennoneofthecolumnsarethestandardwidth.Read/writeVariant.

expression.UseStandardWidth

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexamplesetsthewidthofcolumnBonSheet1inSpreadsheet1tothestandardwidth.

Spreadsheet1.Worksheets("Sheet1").Columns("B").UseStandardWidth

UseXMLDataProperty

ReturnsorsetswhetherthedataaccesspagewillbindtoXMLdata.Read/writeBoolean.

expression.UseXMLData

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

RemarksUsetheXMLLocationpropertytosetwhetherthedataislocatedinanXMLdataisland,oraseparateXMLdatafile.UsetheXMLDataTargetpropertytospecifythepathorIDtousewhenbindingtothedata.

ExampleThisexamplebindsthedataaccesspagetoanXMLdatafile.

SubMSODSC_BeforeInitialBind(DSCEventInfo)

DimdscConstants

SetdscConstants=MSODSC.Constants

'Settheofflinetype.MSODSC.XMLLocation=dscConstants.dscXMLDataFile

'SetthelocationoftheXMLdatatoadatafile.MSODSC.XMLDataTarget="Q1SalesAnalysis.xml"

'BindtotheXMLdata.MSODSC.UseXMLData=True

EndSub

ShowAll

ValueProperty

ValuepropertyasitappliestotheChSegmentBoundaryobject.

ValuepropertyasitappliestotheNameandSpreadsheetobjects.

ValuepropertyasitappliestotheBorders,ByRef,ParameterValue,andPivotDetailCellobjects.

ValuepropertyasitappliestotheRangeobject.

ValuepropertyasitappliestothePivotAggregate,PivotAxisMember,PivotColumnMember,PivotMember,PivotPageMember,PivotResultMemberProperty,PivotRowMember,andSchemaPropertyobjects.

ExampleThisexamplecreatesamergedcellfromthespecifiedrangeandthenplacesavalueinthemergedcell.

SubMergeCells()

Spreadsheet1.Range("A1:C3").Merge

Spreadsheet1.Range("A1").Value="Monday"

EndSub

Value2Property

ReturnsorsetsaVariantrepresentingthecellvalue.Read/write.

expression.Value2

expressionRequired.AnexpressionthatreturnsaRangeobject.

RemarksTheonlydifferencebetweenthispropertyandtheValuepropertyisthattheValue2propertydoesn’tusetheCurrencyandDatedatatypes.Youcanreturnvaluesformattedwiththesedatatypesasfloating-pointnumbersbyusingtheDoubledatatype.

ExampleThisexampleillustratesthedifferencesbetweentheValueandtheValue2properties.

SubValue_vs_Value2()DimrngCell1DimrngCell2

'Setavariabletothecellsusedinthisexample.SetrngCell1=Spreadsheet1.ActiveSheet.Range("A1")SetrngCell2=Spreadsheet1.ActiveSheet.Range("A2")

'Setthenumberformatsusedbythecellsinthisexample.rngCell1.NumberFormat="Currency"rngCell2.NumberFormat="ShortDate"

'SetthevalueofcellA1toacurrencyvalue.rngCell1.Value="$123.456789"

'SetthevalueofcellA2toadate.rngCell2.Value="9/7/1970"

'UsetheValuepropertytoreturnthevalueofcellA1.MsgBox"CurrencyreturnedbytheValueProperty="&_rngCell1.Value

'UsetheValue2propertytoreturnthevalueofcellA1.MsgBox"CurrencyreturnedbytheValue2Property="&_rngCell1.Value2

'UsetheValuepropertytoreturnthevalueofcellA2.

MsgBox"DatereturnedbytheValueProperty="&_rngCell2.Value

'UsetheValue2propertytoreturnthevalueofcellA2.MsgBox"DatereturnedbytheValue2Property="&_rngCell2.Value2EndSub

ShowAll

ValueTypeProperty

ReturnsorsetsaChartBoundaryValueTypeEnumconstantthatrepresentshowtheValuepropertyofthespecifiedsegmentboundaryisinterpreted.Read/write.

expression.ValueType

expressionRequired.AnexpressionthatreturnsaChSegmentBoundaryobject.

RemarksWhenthispropertyissettochBoundaryValuePercent,thentheValuepropertyofthespecifiedsegmentboundarymustbebetween0and1.

ExampleThisexamplebindsChartspace1totheOrderDetailstableintheSQLServerNorthwinddatabase.Then,aformatmapiscreatedthatdisplaysthelargervaluesinthechartwithadarkershadeofblue.

SubWindow_Onload()

DimserSeries1DimsegSegment1AsChSegmentDimchconstants

Setchconstants=ChartSpace1.Constants

'ThefollowingtwolinesofcodebindChartspace1totheOrderDetailstableinthe'NorthwindSQLServerdatabase.ChartSpace1.ConnectionString="Provider=SQLOLEDB.1;PersistSecurityInfo=TRUE;"&_"IntegratedSecurity=SSPI;InitialCatalog=Northwind;"&_"DataSource=DataServer;"ChartSpace1.DataMember="OrderDetails"

'ThefollowingtwolinesofcodebindChartspace1totheQuantityandProductIDfields'intheOrderDetailstable.ChartSpace1.SetDatachconstants.chDimCategories,chconstants.chDataBound,"ProductID"ChartSpace1.SetDatachconstants.chDimValues,chconstants.chDataBound,"Quantity"

'Createaformatmap.ChartSpace1.SetDatachconstants.chDimFormatValues,chconstants.chDataBound,"Quantity"

'SetavariabletothefirstseriesinthefirstchartinChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addasegmenttotheformatmap.SetsegSegment1=serSeries1.FormatMap.Segments.Add

'Measurethesegmentboundariesbaseduponapercentage.segSegment1.Begin.ValueType=chconstants.chBoundaryValuePercentsegSegment1.End.ValueType=chconstants.chBoundaryValuePercent

'Setthebeginningvalueto0%,andtheendingvalueto100%.segSegment1.Begin.Value=0segSegment1.End.Value=1

'Formattheinteriorofthematchingvalues.segSegment1.Begin.Interior.Color="White"segSegment1.End.Interior.Color="Blue"

EndSub

VersionProperty

ReturnstheMicrosoftOfficeWebComponentsversion.Read-onlyString.

expression.Version

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ShowAll

VerticalAlignmentProperty

Returnsorsetstheverticalalignmentofthespecifiedobject.CanbeanXlVAlignconstant.Read/writeVariant.

expression.VerticalAlignment

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexampletop-alignsthecontentsofcellsC7:G10onSheet1inSpreadsheet1.

SubSetAlignment()DimrngAlignDimssConstants

SetssConstants=Spreadsheet1.Constants

SetrngAlign=Spreadsheet1.Worksheets("Sheet1").Range("C7:G10")

'Centerthecontentsoftherangehorizontally.rngAlign.HorizontalAlignment=ssConstants.xlHAlignCenter

'Verticallyalignthecontentsoftherangeatthetopofthecells.rngAlign.VerticalAlignment=ssConstants.xlVAlignTopEndSub

VerticalExtentProperty

YouusetheVerticalExtentpropertytospecifyordeterminetheextentoftheverticalviewoftheChScrollViewobject.ReturnsaLong.Read/writeLong.

expression.VerticalExtent

expressionRequired.AnexpressionthatreturnsaChScrollViewobject.

Remarks

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotareaanditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechartandtheremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.ForinformationonhowthevaluesofthepropertiesoftheChScrollViewobjectrelatetoeachother,seetheChScrollViewobjecttopic.

ExampleThefollowingexampleusestheVerticalExtentMaxpropertytotoggleachartviewbetweenazoomedandunzoomed.

SubToggleZoom()IfobjChart.ChScrollView.VerticalExtent=objChart.ChScrollView.VerticalExtentMaxThen'Zoomchartandmakeitscrollable.objChart.ChScrollView.VerticalExtent=(objChart.ChScrollView.VerticalExtentMax/2)objChart.ChScrollView.HorizontalExtent=(objChart.ChScrollView.HorizontalExtentMax/2)Else'Unzoomchartandremovescrolling.objChart.ChScrollView.VerticalExtent=objChart.ChScrollView.VerticalExtentMaxobjChart.ChScrollView.HorizontalExtent=objChart.ChScrollView.HorizontalExtentMaxEndIfEndSub

VerticalExtentMaxProperty

YouusetheVerticalExtentMaxpropertytospecifyordeterminethemaximumextentoftheverticalviewoftheChScrollViewobject.ReturnsaLong.Read/writeLong.

expression.VerticalExtentMax

expressionRequired.AnexpressionthatreturnsaChScrollViewobject.

Remarks

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotareaanditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechartandtheremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.TheVerticalExtentMaxpropertyrepresentsthetotalheightofachartwhetherthatchartiszoomedornot.ForinformationonhowthevaluesofthepropertiesoftheChScrollViewobjectrelatetoeachother,seetheChScrollViewobjecttopic.

ExampleThefollowingexampleusestheVerticalExtentMaxpropertytotoggleachartviewbetweenazoomedandunzoomed:

SubToggleZoom()IfobjChart.ChScrollView.VerticalExtent=objChart.ChScrollView.VerticalExtentMax'Zoomchart.objChart.ChScrollView.VerticalExtent=(objChart.ChScrollView.objChart.ChScrollView.HorizontalExtent=(objChart.ChScrollView.HorizontalExtentMax/2)Else'Unzoomchart.objChart.ChScrollView.VerticalExtent=objChart.ChScrollView.objChart.ChScrollView.HorizontalExtent=objChart.ChScrollView.HorizontalExtentMaxEndIfEndSub

VerticalPositionProperty

YouusetheVerticalPositionpropertytospecifyordeterminethecurrentverticalviewpositionoftheChScrollViewobject.ReturnsaLong.Read/writeLong.

expression.VerticalPosition

expressionRequired.AnexpressionthatreturnsaChScrollViewobject.

Remarks

YouusemethodsandpropertiesoftheChScrollViewobjecttoretrieveinformationaboutandcontroltheviewofachart.TheportionoftheChartcomponentthatdisplaysthechartitselfisthevisibleplotareaanditcandisplaytheentirechartoraportionofthechart.Whenonlyaportionofthechartisdisplayedinthevisibleplotarea,theeffectisasifyouhavezoomedinonthatportionofthechartandtheremainderofthechartiscontainedwithinavirtualplotareathatextendsbeyondtheboundaryofthevisibleplotarea.ForinformationonhowthevaluesofthepropertiesoftheChScrollViewobjectrelatetoeachother,seetheChScrollViewobjecttopic.

WhentheVerticalPositionpropertyequalszero,thetopoftheplotareawillbeatthetopofthescrollviewwindow.TheVerticalPositionpropertycanbeanegativenumber.ForexampleifVerticalPosition=(-0.25*VerticalExtentMax),theplotareawillbepusheddownby25%ofthevirtualheightoftheplotarea.

ExampleThefollowingcodeshowsdifferentwaysofworkingwiththepropertiesandmethodsoftheChScrollViewobject.

DimlngVPDimlngHPDimlngVEDimlngHEDimlngVEMDimlngHEMDimobjScrollView

SetobjScrollView=ChartSpace1.Charts(0).ScrollViewlngVP=objScrollView.VerticalPositionlngHP=objScrollView.HorizontalPositionlngVE=objScrollView.VerticalExtentlngHE=objScrollView.HorizontalExtentlngVEM=objScrollView.VerticalExtentMaxlngHEM=objScrollView.HorizontalExtentMax

'Togglethescrollviewbetweenunzoomedand200%zoomed:IflngVE=lngVEMAndlngHE=lngHEMThen'Chartisnotzoomedsozoomto200%.objScrollView.VerticalExtentMax=objScrollView.VerticalExtentMax*2objScrollView.HorizontalExtentMax=objScrollView.HorizontalExtentMax*2Else'Chartiszoomed,returnittounzoomedstate.objScrollView.VerticalExtentMax=objScrollView.VerticalExtentobjScrollView.HorizontalExtentMax=objScrollView.HorizontalExtentEndIf

'Forzoomedchart,displaylowerleftcornerofvirtualplotareain'thelowerleftcornerofthevisibleplotarea.IflngVE<>lngVEMOrlngHE<>lngHEMThen'Movebottomedgeofvirtualplotareatobottomofvisibleplotarea.objScrollView.VerticalPosition=objScrollView.VerticalPosition+(lngVEM-lngVM)'Moveleftedgeofvirtualplotareatoleftedgeofvisilbleplotarea.objScrollView.HorizontalPosition=0EndIf

'ThisexampledoesthesamethingasthepreviousexampleusingtheSetPositionmethod.IflngVE<>lngVEMOrlngHE<>lngHEMThenobjScrollView.SetPosition0,objScrollView.VerticalPosition+(lngVEM-lngVE)EndIf

ViewProperty

ReturnsaPivotViewobjectthatrepresentsthecurrentviewforthespecifiedobject.

expression.View

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ViewableRangeProperty

Returnsorsetstherangeofcellsthattheusercanview.Thismakesitpossibletohideworksheetcells(thatcontainintermediatecalculations,forexample).Read/writeString.

expression.ViewableRange

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksDonotconfusethispropertywiththeVisibleRangeproperty,whichreturnsaRangeobjectthatrepresentsallthecellsthatarecurrentlyvisible.

ExampleThisexamplesetstheviewablerangeonthespreadsheet.

SubShrink_Viewable_Range()

'SettheviewablerangeofthewindowtocellsA1:D10.Spreadsheet1.ActiveWindow.ViewableRange="A1:D10"'Resizethespreadsheettoeliminatethegrayarea.Spreadsheet1.Autofit=TrueEndSub

ViewOnlyModeProperty

TrueiftheMicrosoftOfficeWebComponentsareinview-onlymode.TheWebComponentswillbeinview-onlymodeiftheuserdoesnothavetheappropriatelicenseinstalledontheircomputer.Read-onlyBoolean.

expression.ViewOnlyMode

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ViewportLeftProperty

ReturnsorsetsaLongvaluethatrepresentstheleftsideoftheviewabledatarange.Usethispropertytoscrollthatdataareatotheleftbyaspecificnumberofpixels.Read/write.

expression.ViewportLeft

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

RemarksUsetheViewportToppropertytoreturnorsetthetopoftheviewabledatarange.

Settingthispropertytoaninvalidvaluewillresultinarun-timeerror.Forexample,settingthispropertyto5000whenthedatarangecannotbescrolledbythatmanypixelswillresultinarun-timeerror.

ViewportTopProperty

ReturnsorsetsaLongvaluethatrepresentsthetopoftheviewabledatarange.Usethispropertytoscrollthatdataareadownbyaspecificnumberofpixels.Read/write.

expression.ViewportTop

expressionRequired.AnexpressionthatreturnsaPivotDataobject.

RemarksUsetheViewportLeftpropertytoreturnorsettheleftsideoftheviewabledatarange.

Settingthispropertytoaninvalidvaluewillresultinarun-timeerror.Forexample,settingthispropertyto5000whenthedatarangecannotbescrolledbythatmanypixelswillresultinarun-timeerror.

ShowAll

VisibleProperty

ChDataLabel,ChLegendEntry,PivotLabel,andTitleBarobjects:ReturnsorsetsaBooleanthatdetermineswhetherthespecifiedobjectisvisible.SetthispropertytoFalsetohidethespecifiedobject.Read/write.

SheetsandWorksheetsobjects:ReturnsorsetsaVariantthatdetermineswhetherthespecifiedobjectisvisible.SetthispropertytoFalsetohidethespecifiedobject.Read/write.

Windowobject.ReturnsaBooleanthatindicateswhetherthespecifiedwindowisvisible.Read-only.

Worksheetobject.ReturnsorsetsaXlSheetVisibilityconstantthatdeterminesthevisibilityofthespecifiedworksheet.Read/write.

expression.Visible

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexampledisplaysthelegendforthespecifiedchartandhidesthespecifiedlegendentry.

SubShowLegend()

ChartSpace1.Charts(0).HasLegend=TrueChartSpace1.Charts(0).Legend.LegendEntries(1).Visible=False

EndSub

VisibleRangeProperty

ReturnsaRangeobjectthatrepresentsallthecellsthatarecurrentlyvisible.Read-only.

expression.VisibleRange

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksDonotconfusethispropertywiththeViewableRangeproperty,whichreturnsaStringthatspecifiestherangethattheusercanview(partofthatrangemaynotbecurrentlyvisible).

ExampleThisexamplesetsthefonttoboldineveryothercolumninthevisiblerangeontheactiveworksheet.

SubBold_Odd_Columns()DimrngColumn'Loopthroughthevisiblecolumns.ForEachrngColumnInSpreadsheet1.ActiveWindow.VisibleRange.Columns'Setthefonttoboldifthecolumnisodd-numbered.IfrngColumn.ColumnMod2=0ThenrngColumn.Font.Bold=TrueEndIfNextEndSub

ThefunctioninthisexamplereturnsTrueiftheentirecurrentregionforcellA1isvisible(ifthecurrentregionextendsoutsidethevisiblerange,thefunctionreturnsFalse).

FunctionIsCurrentRegionVisible()DimrngCurrentDimrngVisibleDimrngIntersect

'SetthevaribletothecurrentregionofcellA1.SetrngCurrent=Spreadsheet1.ActiveSheet.Cells(1,1).CurrentRegion'Setavariabletothecurrentlyvisiblerange.SetrngVisible=Spreadsheet1.ActiveWindow.VisibleRange

'Setavariabletotheoverlappingportionofthecurrentregion'andthevisiblerange.SetrngIntersect=Spreadsheet1.RectIntersect(rngCurrent,rngVisible)'Iftheoverlappingregionisthesameasthecurrentragion,then'returntrue.IsCurrentRegionVisible=(rngIntersect.Address=rngCurrent.Address)EndFunction

WatermarkBorderProperty

ReturnsaChBorderobjectthatrepresentstheborderofthewatermarkinthespecifieddropzone.UsethepropertiesofthereturnedChBorderobjecttoformattheborderofthedropzone'swatermark.

expression.WatermarkBorder

expressionRequired.AnexpressionthatreturnsaChDropZoneobject.

ExampleThisexampleformatsthebuttonandthewatermarkoftheseriesdropzoneinChartspace1.

SubSetupDropZone()

DimdzSeriesDropZoneDimChConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Thenextthreelinesofcodeformatthebuttonofthedropzone.dzSeriesDropZone.ButtonBorder.Weight=chConstants.owcLineWeightMediumdzSeriesDropZone.ButtonInterior.SetSolid"Red"dzSeriesDropZone.ButtonFont.Size=14

'Thenextthreelinesofcodeformatthewatermarkofthedropzone.dzSeriesDropZone.WatermarkBorder.Color="Red"dzSeriesDropZone.WatermarkFont.Color="Red"dzSeriesDropZone.WatermarkInterior.SetSolid"Green"

EndSub

WatermarkFontProperty

ReturnsaChFontobjectthatrepresentsthefontofthewatermarkinthespecifieddropzone.UsethepropertiesofthereturnedChFontobjecttoformatthefontofthedropzone'swatermark.

expression.WatermarkFont

expressionRequired.AnexpressionthatreturnsaChDropZoneobject.

ExampleThisexampleformatsthebuttonandthewatermarkoftheseriesdropzoneinChartspace1.

SubSetupDropZone()

DimdzSeriesDropZoneDimChConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Thenextthreelinesofcodeformatthebuttonofthedropzone.dzSeriesDropZone.ButtonBorder.Weight=chConstants.owcLineWeightMediumdzSeriesDropZone.ButtonInterior.SetSolid"Red"dzSeriesDropZone.ButtonFont.Size=14

'Thenextthreelinesofcodeformatthewatermarkofthedropzone.dzSeriesDropZone.WatermarkBorder.Color="Red"dzSeriesDropZone.WatermarkFont.Color="Red"dzSeriesDropZone.WatermarkInterior.SetSolid"Green"

EndSub

WatermarkInteriorProperty

ReturnsaChInteriorobjectthatrepresentstheinteriorofthewatermarkinthespecifieddropzone.UsethepropertiesofthereturnedChInteriorobjecttoformattheinteriorofthedropzone'swatermark.

expression.WatermarkInterior

expressionRequired.AnexpressionthatreturnsaChDropZoneobject.

ExampleThisexampleformatsthebuttonandthewatermarkoftheseriesdropzoneinChartspace1.

SubSetupDropZone()

DimdzSeriesDropZoneDimChConstants

SetchConstants=Chartspace1.Constants

'SetavariabletotheseriesdropzoneinChartspace1.SetdzSeriesDropZone=ChartSpace1.DropZones(chConstants.chDropZoneSeries)

'Thenextthreelinesofcodeformatthebuttonofthedropzone.dzSeriesDropZone.ButtonBorder.Weight=chConstants.owcLineWeightMediumdzSeriesDropZone.ButtonInterior.SetSolid"Red"dzSeriesDropZone.ButtonFont.Size=14

'Thenextthreelinesofcodeformatthewatermarkofthedropzone.dzSeriesDropZone.WatermarkBorder.Color="Red"dzSeriesDropZone.WatermarkFont.Color="Red"dzSeriesDropZone.WatermarkInterior.SetSolid"Green"

EndSub

WeightProperty

Returnsorsetstheweightforthespecifiedborderorline.CanbeoneoftheLineWeightEnumconstants,orcanbeNullifthebordersarenotallthesameweight.Read/writeVariant.

expression.Weight

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

ExampleThisexamplesetstheaxislineandborderweightofthecharttothick.

SubFormatChart()

DimchConstants

SetchConstants=ChartSpace1.Constants

ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionValue).Line_.Weight=chConstants.owcLineWeightThick

ChartSpace1.Border.Weight=chConstants.owcLineWeightThick

EndSub

ShowAll

WidthProperty

WidthpropertyasitappliestotheWindowobject.

WidthpropertyasitappliestothePivotAxisMember,PivotColumnMember,PivotFieldSet,PivotPageMember,PivotRowMember,PivotTable,andPivotTotalobjects.

WidthpropertyasitappliestothePivotAggregate,PivotDetailCell,PivotResultAxis,PivotResultColumnAxis,PivotResultDataAxis,PivotResultFilterAxis,PivotResultGroupAxis,PivotResultLabel,PivotResultPageAxis,andPivotResultRowAxisobjects.

WidthpropertyasitappliestotheRangeobject.

RemarksTheAutoFitpropertyofthePivotTablelistissettoFalsewhenthevalueoftheWidthpropertyischanged.

ExampleThisexamplesetsthewidthofthePivotTablelistto150points.

PivotTable1.Object.Width=150

WidthRatioProperty

Returnsorsetsthewidthratioforthespecifiedchartinrelationtotheotherchartsinthechartworkspace.Thedefaultvalueis100.Read/writeLong.

expression.WidthRatio

expressionRequired.AnexpressionthatreturnsaChChartobject.

RemarksForthispropertytohaveanyeffect,youmusthavemorethanonechartinthechartworkspace.Whenmorethanonechartisdisplayed,thechartsaredisplayedinagrid(formoreinformation,seetheHelptopicsfortheChartLayoutandChartWrapCountproperties).Initially,theHeightRatioandWidthRatiopropertiesaresetto100forallchartsinthegrid,andallchartsarethesamesize.

Tochangethewidthofchartsinthegrid,adjusttheWidthRatiopropertysettings.Forexample,ifeachchartisdisplayedinthreecolumnsallchartshaveaninitialWidthRatiosettingof100.Ifyouwantcolumn3tobeonlyhalftheavailablecolumnwidth,setitsWidthRatiosettingto200;theremaininghalfofthechartwidthwillbedividedbetweencolumns1and2.BecausethewidthspecifiedbytheWidthRatiopropertyisrelative,youcansetthispropertyforthethreecolumnsto1,1,2;100,100,200;or20,20,40.allofwhichhavethesameeffect.

Ifthechartworkspacecontainschartsdisplayedinmorethanonecolumn,thelargestWidthRatiosettingineachcolumnisusedtosettherelativewidthfortheentirecolumn.

Thispropertyisusefulforcreatingpriceandvolumestockchartsinwhichthevolumechartishalfthesizeofthepricechart.

WindowNumberProperty

Returnsthewindownumber.Alwaysreturns1inthisversionoftheMicrosoftOfficeSpreadsheetComponent.Read-onlyLong.

expression.WindowNumber

expressionRequired.AnexpressionthatreturnsaWindowobject.

WindowsProperty

ReturnsaWindowscollectionthatrepresentsthewindowsintheopenworkbook.

expression.Windows

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksAlthougheachworksheetintheopenworkbookhasitsownwindow,thispropertyalwaysreturnsareferencetotheactiveworksheet'swindow.

WorkbooksProperty

ReturnsaWorkbookscollectionthatrepresentstheopenworkbook.

expression.Workbooks

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

WorksheetProperty

ReturnsaWorksheetobjectthatrepresentstheworksheetcontainingthespecifiedrange.Read-only.

expression.Worksheet

expressionRequired.AnexpressionthatreturnsaRangeobject.

ExampleThisexampleactivatestheworksheetinSpreadsheet1thatcontainstherangenamed"Revenue."

Spreadsheet1.Range("Revenue").Worksheet.Activate

WorksheetsProperty

ReturnsaWorksheetscollectionthatrepresentstheworksheetsintheopenworkbook.

expression.Worksheets

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

XMLDataProperty

ReturnsorsetstheXMLdataforthespecifiedcomponent.Read/writeString.

expression.XMLData

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

XmlDataBindingsProperty

YouusetheXmlDataBindingspropertytoreturnanXmlDataBindingscollection.Read-onlyXmlDataBindingscollection.

expression.XmlDataBindings

expressionRequired.AnexpressionthatreturnsaWorkbookobject.

Remarks

TheXmlDataBindingscollectioncontainsoneormoreXmlDataBindingobjects.EachXmlDataBindingobjectcontainsconfigurationdatathatbindstheSpreadsheetcomponenttoadataretrievalservice,aSOAPWebService,anXMLfile,oranotherSpreadsheetcomponent.

ExampleThefollowingexampleusestheXmlDataBindingspropertyoftheWorkbookobjecttoreturnamemberoftheXmlDataBindingscollectionandthenworkwiththeXMLthatrepresentsthebindinginformation:

DimobjBindingsDimobjBindingDimstrBindingInfo

SetobjBindings=Spreadsheet1.ActiveWorkbook.XmlDataBindings

ForEachobjBindinginobjBindings'SavetheXMLbindinginformationtoavariable.strBindingInfo=objBinding.BindingData'Workwithbindinginformationhere.Next

XMLDataTargetProperty

ReturnsorsetsaStringthatrepresentsthelocationoftheXMLdatatoloadorsave.Read/write.

expression.XMLDataTarget

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ExampleThisexampleexportsthecurrentdatainthedatasourcecontrolnamedMSODSCtoanXMLdatafile.

SubExportData()

DimdscConstants

SetdscConstants=MSODSC.Constants

'SetthelocationoftheXMLdatatoadatafile.MSODSC.XMLLocation=dscConstants.dscXMLDataFile

'Setthespecifictargettoexportto.MSODSC.XMLDataTarget="Q1SalesAnalysis.xml"

'Exportthecurrentdata.MSODSC.ExportXMLEndSub

ShowAll

XMLLocationProperty

ReturnsorsetsaDscXMLLocationEnumconstantthatspecifieswhethertheXMLdataistobeloadedorsavedfromanXMLdatafileoranXMLdataislandinsideofthecurrentdataaccesspage.Read/write.

expression.XMLLocation

expressionRequired.AnexpressionthatreturnsaDataSourceControlobject.

ExampleThisexampleexportsthecurrentdatainthedatasourcecontrolnamedMSODSCtoanXMLdatafile.

SubExportData()

DimdscConstants

SetdscConstants=MSODSC.Constants

'SetthelocationoftheXMLdatatoadatafile.MSODSC.XMLLocation=dscConstants.dscXMLDataFile

'Setthespecifictargettoexportto.MSODSC.XMLDataTarget="Q1SalesAnalysis.xml"

'Exportthecurrentdata.MSODSC.ExportXML

EndSub

XmlMapProperty

YouusetheXmlMappropertytoreturnanXmlMapobjectrepresentingtheXMLschemamapassociatedwithanXmlDataBindingobject.ReturnsanXmlMapobject.Read-only.

expression.XmlMap

expressionRequired.AnexpressionthatreturnsanXmlDataBindingobject.

Remarks

YoucanusetheMapDatapropertyoftheXmlMapobjecttospecifyordeterminethemappinginformationforthedatasourcespecifiedintheXmlDataBindingobject.

ExampleThefollowingexampleusestheXmlMappropertytoreturntheschemamapassociatedwithabinding.

DimobjBindingsDimobjBindingDimstrMapInfo

SetobjBindings=Spreadsheet1.ActiveWorkbook.XmlDataBindings

ForEachobjBindinginobjBindings'SavetheXMLbindinginformationtoavariable.SetstrMapInfo=objBinding.XmlMap'Workwithbindinginformationhere.Next

XmlMapsProperty

YouusetheXmlMapspropertyoftheWorkbookobjecttoreturnanXmlMapscollection.ReturnsanXmlMapscollection.Read-only.

expression.XmlMaps

expressionRequired.AnexpressionthatreturnsaWorkbookobject.

Remarks

TheXmlMapsobjectisacollectionofalloftheXmlMapobjectsassociatedwithaSpreadsheetcomponent.AnXmlMapisanXMLschemamapthatspecifieshowtomapdatafromadatasourceintheSpreadsheetcomponent.

YoucancreateanewXmlMapobjectbyusingtheAddmethodoftheXmlMapscollection.TheXmlMapobjectisalsoavailablewhenyousettheXmlUrlpropertyofaSpreadsheetcomponenttothenameofanXMLSpreadsheetfile,orastringcontainingproperlyconfiguredXMLdata,thatcontainsthebindingandmappingconfigurationfortheSpreadsheetcomponent.YoucancreateanXMLSpreadsheetfilebycreatingadataboundspreadsheetusingMicrosoftExcelandthensavingtheworkbookasanXMLSpreadsheet.

ExampleThefollowingexampleillustrateshowtousetheXmlMapspropertyoftheWorkBookobjecttoreturnanXmlMapscollection.

DimobjMapsDimobjMapDimstrMapInfo

SetobjMaps=Spreadsheet1.ActiveWorkbook.XmlMaps

ForEachobjMapinobjMaps'SavetheXMLmapinformationtoavariable.strMapInfo=objMap.MapData'Workwithmapinformationhere.Next

XMLURLProperty

ReturnsorsetsaStringrepresentingtheURLtoanExtensibleMarkupLanguage(XML)file.Settingthispropertydiscardsthecurrently-openworkbookandloadsthespecifiedXMLfileintoanewworkbook.Read/write.

expression.XMLURL

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

ExampleThisexampleloadsthecontentsofthespecifiedXMLfileintoSheet1ofSpreadsheet1.

Spreadsheet1.XMLURL="http://example.microsoft.com/Test.xml"

ZOrderProperty

ReturnsorsetsaLongthatspecifiesthetheorderinwhichaseriesisrenderedfromfronttoback.Read/write.

expression.ZOrder

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

RemarksSetthispropertyto0torendertheseriesatthefrontofthechart.

Thispropertyaffectsonlyclusteredoroverlapping3-DArea,Bar,Column,andLinecharts.

AfterDeleteEvent

Occursafterarecordhasbeendeleted,orthedeletionofarecordhasbeencanceled.Usethiseventisyouwanttoperformasetofactionswhenarecordisdeleted.

PrivateSubObject_AfterDelete(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksUsetheStatuspropertyoftheDSCEventInfoobjecttodeterminewhethertherecorddeletionwascanceled.

UsetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttodeterminethedataaccesspage,section,andrecordsetthatwasupdated.

ExampleThisexampledisplaysamessageboxthatindicatesthestatusoftherecorddeletionthatfiredtheevent.

SubMSODSC_AfterDelete(DSCEventInfo)

DimdscConstants

SetdscConstants=MSODSC.Constants

'Checkthestatusoftherecorddeletion.SelectCaseDSCEventInfo.Status

'Therecordwasdeleted.CasedscConstants.dscDeleteOK

MsgBox"Recorddeletedsuccessfully."

'Thedeletionwascanceledviacode.CasedscConstants.dscDeleteCancel

MsgBox"Recorddeletioncanceledbycode."

'Thedelectionwascanceledbytheuser.CasedscConstants.dscDeleteUserCancelMsgBox"Recorddeletioncanceledbyuser."

EndSelect

EndSub

AfterFinalRenderEvent

Occursafterallchartelementshavebeenrendered.

PrivateSubChartSpace_AfterFinalRender(ByValdrawObjectAsChChartDraw)

drawObjectAChChartDrawobject.Usethemethodsandpropertiesofthisobjecttodrawobjectsonthechart.

RemarksYoumustsettheAllowRenderEventspropertytoTrueinordertousethisevent.

AfterInsertEvent

Occursafterarecordhasbeeninserted.Usethiseventifyouwanttoperformasetofactionswhenarecordisinserted.

PrivateSubObject_AfterInsert(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksUsetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttodeterminethedataaccesspage,section,andrecordsetthatwasupdated.

AfterLayoutEvent

Occursafterallchartsinthespecifiedchartcontrolhavebeenlaidout,butbeforetheyhavebeenrendered.Duringthisevent,youcanrepositiontheChTitle,ChLegend,ChChart,andChAxisobjectsofeachchartbychangingtheirLeftandTopproperties.YoucanrepositiontheChPlotAreaobjectbychangingitsLeft,Top,Right,andBottomproperties.Thesepropertiescannotbechangedoutsideofthisevent.

PrivateSubChartSpace_AfterLayout(ByValdrawObjectAsChChartDraw)

drawObjectAChChartDrawobject.Usethemethodsandpropertiesofthisobjecttomanipulatedrawingobjectsonthechart.

RemarksTheAllowLayoutEventspropertymustbesettoTrueinordertocapturethisevent.

ExampleThisexampleusestheAfterLayouteventtomovethetitleforthefirstchartinChartspace1totheleftsideofthechart.Itthenmovesthelegendtowardsthetopofthechart.

PrivateSubChartSpace1_AfterLayout(drawObject)

'Movethetitletotheleftsideofthechart.ChartSpace1.Charts(0).Title.Left=1

'Movethelegendtowardsthetopofthechart.ChartSpace1.Charts(0).Legend.Top=20

EndSub

AfterRenderEvent

OccursaftertheobjectrepresentedbythechartObjectargumenthasbeenrendered.

PrivateSubChartSpace_AfterRender(ByValdrawObjectAsChChartDraw,ByValchartObjectAsObject)

drawObjectAChChartDrawobject.Usethemethodsandpropertiesofthisobjecttomanipulatedrawingobjectsonthechart.

chartObjectTheobjectthathasjustbeenrendered.UsetheTypeNamefunctiontodeterminewhattypeofobjecthasjustbeenrendered.

RemarksYoumustsettheAllowRenderEventsandAllowPointsRenderEventspropertiestoTrueinordertousethiseventwithallchartobjects.

ExampleThisexampleaddsatextstringtotheupper-leftcorneroftheplotareaeachtimethatthechartisredrawn.

SubChartSpace1_AfterRender(drawObject,chartObject)

DimchChart1

SetchChart1=ChartSpace1.Charts(0)'Afterthelegendhasbeenrendered,thenaddthetext'tothechart.IfTypeName(chartObject)="ChLegend"ThendrawObject.DrawText"2000Sales",chChart1.PlotArea.Left+5,_chChart1.PlotArea.Top

EndIf

EndSub

ThisexampleillustrateshowyoucanusetheBeforeRenderandAfterRendereventstogethertocreatecustomgridlines.TheBeforeRendereventcancelstherenderingofthegridlinesandtheAfterRendereventdrawscustomgridlines.

SubChartSpace1_BeforeRender(drawObject,chartObject,Cancel)

'Checktoseeifthenextobjecttoberendered'isagridline.IfTypeName(chartObject)="ChGridlines"Then

'Canceltherenderingofgridlines.

Cancel.Value=True

EndIf

EndSub

SubChartSpace1_AfterRender(drawObject,chartObject)

DimchChart1DimplPlotAreaDimlLeftDimlRightDimlHeightDimlTopDimlIncrementDimchConstantsDimiCtr

SetchConstants=ChartSpace1.Constants

'SetavariabletothefirstchartinChartspace1.SetchChart1=ChartSpace1.Charts(0)

'Setavariabletotheplotareaofthechart.SetplPlotArea=chChart1.PlotArea

'Checktoseeiftherenderedobjectisagridline.IfTypeName(chartObject)="ChGridlines"Then

'Thenextfourlinesofcodeusetheextentsof'theplotareatocalculatethedimensionsoftheline'tobedrawn.lLeft=plPlotArea.Left

lTop=plPlotArea.ToplRight=plPlotArea.RightlHeight=plPlotArea.Bottom-lTop

'Determinetheincrementtousebetweengridlines.'Changethedivisortoadjusttheincrement.lIncrement=lHeight/10

'Thenextthreelinesofcodesetthepropertiesofthe'linetobedrawn.drawObject.Line.DashStyle=chConstants.chLineRoundDotdrawObject.Line.Color="Green"drawObject.Line.Weight=chConstants.owcLineWeightMedium

ForiCtr=1To9

'Drawtheline.drawObject.DrawLinelLeft,lTop+iCtr*lIncrement,_lRight,lTop+iCtr*lIncrement

NextEndIf

EndSub

AfterUpdateEvent

Occursafterarecordisupdatedwithnewdataortherecordlosesfocus.

PrivateSubObject_AfterUpdate(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksUsetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttodeterminethedataaccesspage,section,andrecordsetthatwasupdated.

ExampleThisexampledisplaysinformationaboutthesectionthatcontainstherecordthatwasupdated.

SubMSODSC_AfterUpdate(DSCInfo)

MsgBoxDSCInfo.Section.HTMLContainer.All(1).InnerText

EndSub

BeforeCollapseEvent

Occurswhenthecollapsebuttonisclickedonadataaccesspage.

PrivateSubObject_BeforeCollapse(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

BeforeContextMenuEvent

Occursbeforeacontextmenuistobeshown.Acontextmenuisshownwhentheuserright-clicksortheypresstheApplicationkey.

PrivateSubObject_BeforeContextMenu(ByValxAsLong,ByValyAsLong,ByValMenuAsByref,ByValCancelAsByRef)

xRepresentsthex-coordinatewherethecontextmenuistoappear.

yRepresentsthey-coordinatewherethecontextmenuistoappear.

MenuSettheValuepropertyofthisobjecttoanarraythatcontainsthemenuitemstodisplay.

CancelSettheValuepropertyofthisobjecttoTruetocancelthekeystroke.

RemarksUsethiseventtocustomizethecontextmenusintheMicrosoftOfficeWebComponents.

ExampleThisexampledisplaysacustomcontextmenu.Themenucontainsfouroptions,thelastoptiondisplaysasubmenu.

SubSpreadsheet1_BeforeContextMenu(x,y,Menu,Cancel)

DimcmContextMenu(4)DimcmClearSubMenu(2)

cmClearSubMenu(0)=Array("&All","ClearAll")cmClearSubMenu(1)=Array("&Formats","ClearFormats")cmClearSubMenu(2)=Array("&Values","ClearValues")

cmContextMenu(0)=Array("Cu&t","owc2")cmContextMenu(1)=Array("&Copy","owc3")cmContextMenu(2)=Array("&Paste","owc4")cmContextMenu(3)=EmptycmContextMenu(4)=Array("Clea&r",cmClearSubMenu)

Menu.Value=cmContextMenu

EndSub

BeforeDeleteEvent

Occursbeforearecordisdeleted.Usethiseventifyouwanttoapplyasetofconditionsbeforearecordisdeleted.

PrivateSubObject_BeforeDelete(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksSettheReturnValuepropertyoftheDSCEventInfoobjecttoFalsetocancelthedeletionofarecord.Whenyoucancelthedeletionofarecord,theAfterDeleteeventstillfires.

UsetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttodeterminethedataaccesspage,section,andrecordsetthatwasupdated.

UsetheDisplayAlertpropertytodeterminewhetherornottheuserispromptedwhenthiseventiscalled.

ExampleThisexamplecancelsthedeletionofarecordifthe"Discontinued"fieldissettheNo.

SubMSODSC_BeforeDelete(DSCEventInfo)

DimtxtDiscontinued

'Setavariabletothetextboxthatcontainsthevalue'oftheDiscontinuedfieldfortherecordthatistobedeleted.SettxtDiscontinued=DSCEventInfo.Section.HTMLContainer_.Children("Discontinued")

'Checkthevalueofthecontrol.IftxtDiscontinued.Value="No"Then

'Displayamessagetotheuser.Msgbox"Donotdeleteproductsthathavenot"&_"beendiscontinued."

Cancelthedeletionoftherecord.DSCEventInfo.ReturnValue=FalseEndIf

EndSub

BeforeExpandEvent

Occurswhenevertheexpandbuttonisclickedonadataaccesspage.

PrivateSubObject_BeforeExpand(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

BeforeFirstPageEvent

Occursbeforethefirstsetofrecordsisdisplayedonabandeddataaccesspage.

PrivateSubObject_BeforeFirstPage(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

BeforeInitialBindEvent

Occursbeforethecontrolsonthespecifieddataaccesspageareboundtotherecordsetforthefirsttime.Usethiseventtosetthepropertiesforthedataaccesspagebeforethecontrolsarepopulatedwithdata.

PrivateSubObject_BeforeInitialBind(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksThiseventdoesnotsupportanyoftheDSCEventInfoproperties.

BeforeInsertEvent

Occurswhenthefirstcharacterisenteredintoanewrecord,butbeforetherecordisaddedtotherecordset.

PrivateSubObject_BeforeInsert(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksSettheReturnValuepropertyoftheDSCEventInfoobjecttoFalsetocanceltheinsertionofanewrecord.

YoucanusetheDataPagepropertyoftheDSCEventInfoobjecttogetmoreinformationaboutthedataaccesspage.

ExampleThisexampleusestheBeforeInserteventtopreventtheuserfromaddinganotherrecordtotherecordsetonceitreaches75records.

SubMSODSC_BeforeInsert(DSCEventInfo)DimrstCurrentData

'Setavariabletotherecordset.SetrstCurrentData=DSCEventInfo.DataPage.Recordset

'Checktoseeiftherecordsethasreacheditslimit.IfrstCurrentData.RecordCount>=75then

'Displayamessagetotheuser.MsgBox"Cannotaddanymorerecords."

'Canceltheinsertionoftherecord.DSCEventInfo.ReturnValue=FalseEndIfEndSub

BeforeKeyDownEvent

Occurswhenauserpressesakeyonthekeyboard,butbeforethecontrolhasprocessedthekeystroke.Iftheuserholdsthekeydown,thiseventrepeatsitselfatthekey-repeatintervalthathasbeensetontheuser’scomputer.

PrivateSubObject_BeforeKeyDown(ByValKeyCodeAsLong,ByValShiftAsLong,ByValCancelAsByRef)

ObjectAChartSpace,PivotTable,orSpreadsheetobject.

KeyCodeAnintegerthatrepresentsthekeycodeofthekeythatwaspressedorreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeys.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,and4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,norALTkeyswerepressed.

CancelSettheValuepropertyofthisobjecttoTruetocancelthekeystroke.

RemarksCancelingthiseventalsocancelstheBeforeKeyPressandKeyPressevents,butdoesnotpreventthetheKeyDownorKeyUpeventsfromfiring.

Thesequenceofkeyboard-relatedeventsis:

1. BeforeKeyDown

2. KeyDown

3. BeforeKeyPress

4. KeyPress

5. BeforeKeyUp

6. KeyUp

BeforeKeyPressEvent

Occurswhenauserpressesandreleasesakeyonthekeyboard,butbeforethecontrolhasprocessedthekeystroke.Iftheuserholdsthekeydown,thiseventrepeatsitselfatthekey-repeatintervalthathasbeensetontheuser’scomputer.

PrivateSubObject_BeforeKeyPress(ByValKeyAsciiAsLong,ByValCancelAsByRef)

ObjectAChartSpace,PivotTable,orSpreadsheetobject.

KeyAsciiAnintegerthatrepresentsthekeycodeofthekeythatwaspressedorreleased.

CancelSettheValuepropertyofthisobjecttoTruetocancelthekeystroke.

RemarksCancelingthiseventdoesnotpreventtheKeyPressorKeyUpeventsfromfiring.

Thesequenceofkeyboard-relatedeventsis:

1. BeforeKeyDown

2. KeyDown

3. BeforeKeyPress

4. KeyPress

5. BeforeKeyUp

6. KeyUp

BeforeKeyUpEvent

Occurswhenauserreleasesakeyonthekeyboard,butbeforethecontrolhasprocessedthekeystroke.

PrivateSubObject_BeforeKeyUp(ByValKeyCodeAsLong,ByValShiftAsLong,ByValCancelAsByRef)

ObjectThenameoftheChartSpace,PivotTable,orSpreadsheetobjectthatthiseventappliesto..

KeyCodeAnintegerthatrepresentsthekeycodeofthekeythatwaspressedorreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeys.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,and4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,orALTkeyswerepressed.

CancelSettheValuepropertyofthisobjecttoTruetocancelthekeystroke.

RemarksCancelingthiseventdoesnotpreventtheKeyUpeventfromfiring.

Thesequenceofkeyboard-relatedeventsis:

1. BeforeKeyDown

2. KeyDown

3. BeforeKeyPress

4. KeyPress

5. BeforeKeyUp

6. KeyUp

BeforeLastPageEvent

Occursbeforethelastsetofrecordsisdisplayedonabandeddataaccesspage.

PrivateSubObject_BeforeLastPage(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

BeforeNextPageEvent

Occursbeforethenextsetofrecordsisdisplayedonabandeddataaccesspage.

PrivateSubObject_BeforeNextPage(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

BeforeOverwriteEvent

Occurswhenanexistingfileisabouttobeoverwritten.

PrivateSubObject_BeforeOverwrite(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksThiseventmayoccurwhenyouusetheExportXMLmethodtoexportthecurrentrecordset.SettheReturnValuepropertyoftheDSCEventInfoobjecttoFalsetopreventtheexistingfilefrombeingoverwritten.SettheDisplayAlertpropertyoftheDSCEventInfoobjecttodscDataAlertContinuetooverwritethefilewithoutpromptingtheuser.

Note:FilesthatwerenotcreatedbytheDataSourceControlwillnotbeoverwritten.

ExampleThisexampleallowsafilecreatedbytheExportXMLmethodtobeoverwrittenwithoutpromptingtheuser.

SubMSODSC_BeforeOverwrite(DSCEventInfo)

DimdscConstantsSetdscConstants=MSODSC.Constants

'Don'talerttheuserwhenoverwritinganexistingfile.DSCEventInfo.DisplayAlert=dscConstants.dscDataAlertContinue

EndSub

BeforePreviousPageEvent

Occursbeforetheprevioussetofrecordsisdisplayedonabandeddataaccesspage.

PrivateSubObject_BeforePreviousPage(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

BeforeRenderEvent

OccursbeforetheobjectpassedinthechartObjectargumenthasbeenrendered.

PrivateSubObject_BeforeRender(ByValdrawObjectAsChChartDraw,ByValchartObjectAsObject,CancelAsByRef)

ObjectThenameoftheChartSpaceobjectthatyouaretrappingthiseventfor.

drawObjectAreferencetotheChChartDrawobject.UsetheDrawTypepropertyofthereturnedobjecttodeterminewhattypeofrenderingisabouttooccur.

chartObjectTheobjectthatistoberendered.UsetheTypeNamefunctiontodeterminethetypeoftheobject.

CancelSettheValuepropertyofthisobjecttoTruetocanceltherenderingoftheobjectrepresentedbychartObject.

RemarksYoumustsettheAllowRenderEventsandAllowPointsRenderEventspropertiestoTrueinordertousethiseventwithallchartobjects.

ExampleThisexampleillustrateshowyoucanusetheBeforeRenderandAfterRendereventstogethertocreatecustomgridlines.TheBeforeRendereventcancelstherenderingofthegridlinesandtheAfterRendereventdrawscustomgridlines.

SubChartSpace1_BeforeRender(drawObject,chartObject,Cancel)

'Checktoseeifthenextobjecttoberendered'isagridline.IfTypeName(chartObject)="ChGridlines"Then

'Canceltherenderingofgridlines.Cancel.Value=TrueEndIfEndSub

SubChartSpace1_AfterRender(drawObject,chartObject)DimchChart1DimplPlotAreaDimlLeftDimlRightDimlHeightDimlTopDimlIncrementDimchConstantsDimiCtr

SetchConstants=ChartSpace1.Constants

'SetavariabletothefirstchartinChartspace1.SetchChart1=ChartSpace1.Charts(0)

'Setavariabletotheplotareaofthechart.SetplPlotArea=chChart1.PlotArea

'Checktoseeiftherenderedobjectisagridline.IfTypeName(chartObject)="ChGridlines"Then

'Thenextfourlinesofcodeusetheextentsof'theplotareatocalculatethedimensionsoftheline'tobedrawn.lLeft=plPlotArea.LeftlTop=plPlotArea.ToplRight=plPlotArea.RightlHeight=plPlotArea.Bottom-lTop

'Determinetheincrementtousebetweengridlines.'Changethedivisortoadjusttheincrement.lIncrement=lHeight/10

'Thenextthreelinesofcodesetthepropertiesofthe'linetobedrawn.drawObject.Line.DashStyle=chConstants.chLineRoundDotdrawObject.Line.Color="Green"drawObject.Line.Weight=chConstants.owcLineWeightMedium

ForiCtr=1To9

'Drawtheline.drawObject.DrawLinelLeft,lTop+iCtr*lIncrement,_lRight,lTop+iCtr*lIncrementNextEndIfEndSub

ShowAll

BeforeScreenTipEvent

BeforeScreenTipeventasitappliestotheChartSpaceobject.

BeforeScreenTipeventasitappliestothePivotTableobject.

RemarksUsethiseventtocustomizeScreenTipsdisplayedinachartorPivotTablelist.

BeforeUpdateEvent

Occurswhendataischanged,butbeforetherecordsetisupdated.Usethiseventtovalidatedatabeforeitiscommittedtothedatabase.

PrivateSubObject_BeforeUpdate(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksUsetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttodeterminethedataaccesspage,section,andrecordsetthatwasupdated.

SettheReturnValuepropertyoftheDSCEventInfoobjecttoFalsetocanceltheupdate.

ExampleThisexamplecancelstheupdatingoftherecordsetwhentheuserentersavaluegreaterthan0fortheUnitsOnOrderfieldwhentheUnitsInStockfieldisgreaterthan100.

SubMSODSC_BeforeUpdate(DSCEventInfo)

DimtxtUnitsOnOrderDimtxtUnitsInStock

'Setavariabletothetextboxthatcontainsthevalue'fortheUnitsOnOrderfield.SettxtUnitsOnOrder=DSCEventInfo.Section.HTMLContainer_.Children("UnitsOnOrder")

'Setavariabletothetextboxthatcontainsthevalue'fortheUnitsInStockfield.SettxtUnitsInStock=DSCEventInfo.Section.HTMLContainer_.Children("UnitsInStock")

'CheckthevalueoftheUnitsOnOrderField.IfCLng(txtUnitsOnOrder.Value)>0then

'CheckthevalueoftheUnitsInStockField.IfCLng(txtUnitsInStock.Value)>100then

'Displayamessagetotheuser.MsgBox"Don'treorderthepartuntilfewerthan100areinstock."

'Canceltheupdate.DSCEventInfo.ReturnValue=False

EndIfEndIf

EndSub

BindingAddedEvent

OccurswhenaneworexistingXmlDataBindingobjectisaddedormodifiedthroughtheEditQuerycommand.

PrivateSubSpreadsheet1_BindingAdded(BindingId)

BindingIdTheuniqueIDofanXmlDataBindingobject.

Remarks

TheBindingIdisautomaticallygeneratedbytheSpreadsheetcomponentwhenyoubindtoadataretrievalserviceconnection(.uxdc)file.MicrosoftExcelalsoautomaticallygeneratestheBindingIdwhenyouuseExceltocreateadata-boundspreadsheetandlatersaveitasanXMLSpreadsheetfile.IntheXMLSpreadsheetfile,theXMLfragmentthatcontainstheBindingIdlookssomethinglikethefollowing:

<x2:Bindingx2:ID="Bind_id89929"x2:LoadMode="Normal"x2:Async="False">YoucanalsomanuallyassignaBindingIdvaluebyaddingtherelevantXMLfragmentthatcontainsdata-bindingdetailsintoanXMLSpreadsheetfile.

ExampleThefollowingexampleinMicrosoftVisualBasicScriptingEdition(VBScript)tracksthenumberofXmlDataBindingobjecteventsanddisplaystheBindingIdofthegiveneventwhenitoccurs.

'globalXmlDataBindingobjectBindingAddedeventcounter.DimgintCounterBindingAddedgintCounterBindingAdded=0

SubSpreadsheet1_BindingAdded(BindingId)

gintCounterBindingAdded=gintCounterBindingAdded+1MsgBox("BindingAddedandBindingIDis:"&BindingId)

EndSub

BindingCompletedEvent

OccursafterdataissuccessfullyloadedintoorexportedfromamapthroughaRefreshorUpdatemethod.

PrivateSubSpreadsheet_BindingCompleted(BindingId,Action)

BindingIdRequiredString.TheuniqueIDofanXmlDataBindingobject.YoucanalsomanuallyassignaBindingIdvaluebyaddingtherelevantXMLfragmentthatcontainsdata-bindingdetailsintoanXMLSpreadsheetfile.

ActionReferstothetypeofbindingoperationthatwascompleted.Thepossiblevaluesare"Refresh"and"Update".

Remarks

AuniqueBindingIdisautomaticallygeneratedbytheSpreadsheetcomponentwhenyoubindtoadataretrievalserviceconnection(.uxdc)file.MicrosoftExcelalsoautomaticallygeneratesaBindingIdwhenyouuseExceltocreateadata-boundspreadsheetandlatersaveitasanXMLspreadsheetfile.IntheXMLSpreadsheetfile,theXMLfragmentthatcontainstheBindingIdlookssomethinglikethefollowing:

<x2:Bindingx2:ID="bind_id0"x2:Async="True"xmlns:x2="urn:schemas-microsoft-com:office:excel2"xmlns:dsp="http://schemas.microsoft.com/sharepoint/dsp"xmlns:udc="http://schemas.microsoft.com/data/udc"xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/"xmlns:udcs="http://schemas.microsoft.com/data/udc/soap"><x2:MapID>map_id0</x2:MapID><udc:DataSourceMajorVersion="1"MinorVersion="0"><udc:Name/><udc:TypeType="SOAP"MajorVersion="1"MinorVersion="0"> <udc:SubTypeType="DSP"MajorVersion="1"MinorVersion="0"/></udc:Type><udc:ConnectionInfoPurpose="Query"><udcs:SOAPAction>http://schemas.microsoft.com/sharepoint/dsp/queryRequest</udcs:SOAPAction><udcs:Locationhref="Data_Retrieval_Services_URL">SQLDataAdapter</udcs:Location><soap-env:Body><dsp:queryRequest><dsp:dsQueryselect="/database[@id='Database_Name']/table[@id='Table_Name']"resultContent="dataOnly"><dsp:QueryRowLimit="10"QueryType="DSPQ"><dsp:Fields><dsp:FieldName="Column_Name"/></dsp:Fields></dsp:Query></dsp:dsQuery>

</dsp:queryRequest></soap-env:Body><soap-env:Header><dsp:versions><dsp:version>1.0</dsp:version></dsp:versions><dsp:dataRoot><dsp:root>SQL_Server</dsp:root></dsp:dataRoot><dsp:requestservice="DspSql"document="content"method="query"/><dsp:authentication><dsp:basic><dsp:useExplicit><dsp:userId>user_name</dsp:userId><dsp:password>password</dsp:password></dsp:useExplicit></dsp:basic></dsp:authentication></soap-env:Header></udc:ConnectionInfo></udc:DataSource></x2:Binding>

TheBindingCompletedeventistriggeredafterdataissuccessfullyloadedintoorexportedoutofamapthroughaRefreshorUpdatemethod.ThiseventisalsotriggeredwhenthepageisfirstrenderedforquerybindingswheretheLoadModeattributeoftheBindingelementissetto"normal".

Duringanasynchronousbinding,somemethodsrelatedtodatabindingwillgeneraterun-timeerrorssayingthattherequestedoperationcannotbecompletedbecauseanasynchronousbindingisinprogress.Callstothesemethodssucceedwhentheasynchronousbindingisdone.Formoreinformation,seetheXMLDataBindingobjectdocumentation.

SolutiondevelopersshouldtraptheBindingCompletedand

BindingErroreventstofindoutwhenthebindingisfinished.NotethatusingtheBindingCompletedeventtoselectanXMLrowdoesnotsendthatrowtoapart-to-partbindingconsumerwhenthepageisloaded.UsetheWindow.Onloadeventforthatpurpose.

ThefollowingXMLfragmentexampleshowsLoadMode="normal":

<x2:Bindingx2:ID="Bind_id89929"x2:LoadMode="normal"x2:Async="true"xmlns:x2="http://schemas.microsoft.com/office/excel/2003/xml"> ...</x2:Binding>

ThefollowingexampleshowshowtotraptheBindingCompletedeventfromscriptrunninginaWebpagewhenthepageisfirstloadedandwhenevertheuserrefreshesthebounddata(thebehaviorwhentheLoadModeattributeissetto"normal").Toworkcorrectly,youmustputtheeventhandlerfortheBindingCompletedeventina<SCRIPT>tagthatislocatedbeforethe<OBJECT>tagoftheSpreadsheetcomponent.

<SCRIPTlanguage=vbscriptfor="Spreadsheet1"event="BindingCompleted(bindingID,Action)">

IfSpreadsheet1.ActiveWorkbook.XmlDataBindings.Item(bindingID).CanQuery=TrueThen

MsgBox"BindingCompleted."

EndIf

</SCRIPT>

<OBJECTid=Spreadsheet1classid=CLSID:0002E559-0000-0000-C000-000000000046>...</OBJECT>

BindingDeletedEvent

OccurswhenanewXmlDataBindingobjectisdeleted.

PrivateSubSpreadsheet_BindingDeleted(BindingId)

BindingIdRequiredString.TheuniqueIDofanXmlDataBindingobject.TheuniqueBindingIdisautomaticallygeneratedbytheSpreadsheetcomponentwhenyoubindtoadataretrievalserviceconnection(.uxdc)file.MicrosoftExcelalsoautomaticallygeneratestheBindingIdwhenyouuseExceltocreateadata-boundspreadsheetandlatersaveitasanXMLSpreadsheetfile.IntheXMLSpreadsheetfile,theXMLfragmentthatcontainstheBindingIdlookssomethinglikethefollowing:<x2:Bindingx2:ID="Bind_id89929"x2:LoadMode="normal"x2:Async="False">.YoucanalsomanuallyassignaBindingIdvaluebyaddingtherelevantXMLfragmentthatcontainsdata-bindingdetailsintoanXMLSpreadsheetfile.

ExampleThefollowingexampletracksthenumberofBindingDeletedeventsanddisplaystheBindingIdofthegiveneventwhenitoccurs.

'globalXmlDataBindingobjectBindingDeletedeventcounter.DimgintCounterBindingDeletedgintCounterBindingDeleted=0

SubSpreadsheet1_BindingDeleted(BindingId)gintCounterBindingDeleted=gintCounterBindingDeleted+1MsgBox"BindingDeletedandBindingIdis:"&BindingIdEndSub

BindingErrorEvent

OccursafteranerrorisreceivedfromthedatasourcefollowingacalltoRefreshorUpdatemethodoperation.

PrivateSubSpreadsheet1_BindingError(BindingId,Action,DialogText,FaultCode,FaultString,FaultDetail)

BindingIdRequiredString.TheuniqueIDofanXmlDataBindingobject.TheuniqueBindingIdisautomaticallygeneratedbytheSpreadsheetcomponentwhenyoubindtoadataretrievalserviceconnection(.uxdc)file.MicrosoftExcelalsoautomaticallygeneratestheBindingIdwhenyouuseExceltocreateadata-boundspreadsheetandlatersaveitasanXMLSpreadsheetfile.IntheXMLSpreadsheetfile,theXMLfragmentthatcontainstheBindingIdlookssomethinglikethefollowing:<x2:Bindingx2:ID="Bind_id89929"x2:LoadMode="normal"x2:Async="False">.YoucanalsomanuallyassignaBindingIdvaluebyaddingtherelevantXMLfragmentthatcontainsdata-bindingdetailsintoanXMLSpreadsheetfile.

ActionRequiredString.Referstothetypeofbindingoperationthatwascompleted.Thepossiblevaluesare"Refresh"and"Update".

DialogTextRequiredString.Referstotheerrorstringmappedtothefaultcodereceived.

FaultCodeRequiredString.Correspondstothe<FaultCode>elementinthefaultmessage—forexample,"Client.Dsp.Authentication".

FaultStringRequiredString.Correspondstothe<FaultString>elementinthefaultmessage—forexample,"Can'tlogonuser<username>".

FaultDetailRequiredString.Correspondstothe<Detail>elementinthefaultmessage—forexample,<dsp:queryResponsestatus="failure"xmlns:dsp="http://schemas.microsoft.com/sharepoint/dsp"></dsp:queryResponse><dsp:author>authorName</dsp:author>ThesestringsmatchthestructureofdataretrievalserviceconnectionSOAPfaultmessages.

Remarks

ForXMLSpreadsheetfilesandpart-to-partbindings,theDialogTexterrorstringwillbepresentinthefaultmessagebutnotintheFaultCode,FaultStringandFaultDetailparameters.ForarbitrarySOAPbindings,FaultCodeandFaultStringarereturnedbyallXMLWebservicesfaultmessages—buttheoptionalelementFaultDetailisnotreturnedbymostXMLWebservices,includingdataretrievalservices.

WhenaRefreshorUpdatemethodfails,theBindingErroreventfiresandanerrordialogboxisdisplayed.Tocatchtheerrorinscript,solutiondevelopersshouldtraptheBindingErrorevent.Theerrorwon'tbereturnedbytheRefreshorUpdatemethodsorbyInternetExplorer.WhenRefreshorUpdateiscalledonanasynchronousbinding,thesemethodsreturnimmediately.

SolutiondevelopersshouldtraptheBindingCompletedandBindingErroreventstofindoutwhenthebindingisfinished.NotethatusingtheBindingCompletedeventtoselectanXMLrowdoesnotsendthatrowtoapart-to-partbindingconsumerwhenthepageisloaded.UsetheWindow.Onloadeventforthispurpose.

BindingUpdatedEvent

OccurswhentheBindingDatapropertyofanexistingXmlDataBindingobjectischanged.

PrivateSubSpreadsheet1_BindingUpdated(BindingId)

BindingIdRequiredString.TheuniqueIDofanXmlDataBindingobject.

BindingIdRequiredString.TheuniqueIDofanXmlDataBindingobject.TheuniqueBindingIdisautomaticallygeneratedbytheSpreadsheetcomponentwhenyoubindtoadataretrievalserviceconnection(.uxdc)file.MicrosoftExcelalsoautomaticallygeneratestheBindingIdwhenyouuseExceltocreateadata-boundspreadsheetandlatersaveitasanXMLSpreadsheetfile.IntheXMLSpreadsheetfile,theXMLfragmentthatcontainstheBindingIdlookssomethinglikethefollowing:<x2:Bindingx2:ID="Bind_id89929"x2:LoadMode="normal"x2:Async="False">.YoucanalsomanuallyassignaBindingIdvaluebyaddingtherelevantXMLfragmentthatcontainsdata-bindingdetailsintoanXMLSpreadsheetfile.

Remarks

TheXmlDataBindingobjectcontainsconfigurationdataintheformofXML.YoucanusetheBindingDatapropertytoreturnorsettheconfigurationdataforagivenXmlDataBindingobject.

ShowAll

ButtonClickEvent

Occurswhenevertheuserclicksanavigationbutton.

PrivateSubRecordNavigationControl_ButtonClick(NavButtonAsNavButtonEnum)

NavButtonSpecifiesthebuttonthat,whenclicked,triggerstheButtonClickevent.CanbeoneoftheNavButtonEnumconstants.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

ChangeEvent

Occurswheneverdatainoneormorecellschanges.Botheditsandcopy-and-pasteoperationscausethiseventtooccur.

PrivateSubRange_Change()

RemarksThiseventoccursaftertheEndEditevent;atthispoint,thedatahasalreadybeenchangedandthechangecannotbecanceled.

ThiseventrequirestheWithEventskeyword,soitcannotbeusedwithVBScriptorJScript.

ExampleThefollowingexampleupdatesalabelcontrolonaVisualBasicformwhenthevalueincellA1ofSheet1inSpreadsheet1changes.

DimWithEventsrngRange1AsRange

PrivateSubForm_Load()

'Setavariabletotherangeforwhichyouwanttocapture'theChangeevent.SetrngRange1=Spreadsheet1.Worksheets("Sheet1").Range("A1")

EndSub

PrivateSubrngRange1_Change()'ChangethecaptionofLabel1tothecurrentvalue'ofcellA1.Label1.Caption=rngRange1.ValueEndSub

ClickEvent

Occurswhenevertheuserclicksthespecifiedcontrol.

PrivateSubobject_Click()

objectAChartSpace,PivotTable,orSpreadsheetobject.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

CommandBeforeExecuteEvent

Occursbeforeacommandisexecuted.Usethiseventwhenyouwanttoimposecertainrestrictionsbeforeacommandisexecuted.

PrivateSubobject_CommandBeforeExecute(ByValCommandAsVariant,ByValCancelAsByRef)

objectAChartSpace,PivotTable,orSpreadsheetobject.

CommandRequired.Thecommandthathasbeenexecuted.

CancelRequired.SettheValuepropertyofthisobjecttoTruetocancelthecommand.

RemarksTheOCCommandId,ChartCommandIdEnum,PivotCommandId,andSpreadsheetCommandIdconstantscontainlistsofthesupportedcommandsforeachoftheMicrosoftOfficeWebComponents.

ExampleThisexamplerefreshesPivotTable1whentheexportcommandisinvokedsothatthelatestdataisexportedtoMicrosoftExcel.

SubPivotTable1_CommandBeforeExecute(Command,Cancel)

DimptConstants

SetptConstants=PivotTable1.Constants

'ChecktoseeiftheExportcommand'hasbeeninvoked.IfCommand=ptConstants.plCommandExportThen

'RefreshthePivotTablelist.PivotTable1.Refresh

EndIf

EndSub

CommandCheckedEvent

OccurswhenthethespecifiedMicrosoftOfficeWebComponentdetermineswhetheracommandischecked.

PrivateSubobject_CommandChecked(ByValCommandAsVariant,ByValCheckedAsByRef)

objectAChartSpace,PivotTable,orSpreadsheetobject.

CommandRequired.Thecommandthathasbeenexecuted.

CheckedRequired.SettheValuepropertyofthisobjecttoTruetouncheckthecommand.

RemarksTheOCCommandId,ChartCommandIdEnum,PivotCommandId,andSpreadsheetCommandIdconstantscontainlistsofthesupportedcommandsforeachWebcomponent.

CommandEnabledEvent

OccurswhenthethespecifiedMicrosoftOfficeWebComponentcommandisenabled.

PrivateSubobject_CommandEnabled(ByValCommandAsVariant,ByValEnabledAsByRef)

objectAChartSpace,PivotTable,orSpreadsheetobject.

CommandRequired.Thecommandthathasbeenexecuted.

EnabledRequired.SettheValuepropertyofthisobjecttoTruetodisablethecommand.

RemarksTheOCCommandID,ChartCommandIDEnum,PivotCommandId,andSpreadsheetCommandIdconstantscontainlistsofthesupportedcommandsforeachWebcomponent.

CommandExecuteEvent

Occursafteracommandisexecuted.Usethiseventwhenyouwanttoexecuteasetofcommandsafteraparticularcommandisexecuted.

PrivateSubobject_CommandExecute(ByValCommandAsVariant,ByValSucceededAsBoolean)

objectAChartSpace,PivotTable,orSpreadsheetobject.

CommandThecommandthathasbeenexecuted.

SucceededReturnsTrueifthecommandsucceeded.

RemarksTheOCCommandId,ChartCommandIdEnum,PivotCommandId,andSpreadsheetCommandIdconstantscontainlistsofthesupportedcommandsforeachoftheOfficeWebComponents.

ExampleThisexamplewritesthecurrentdateandtimetoaHTMLtextboxcontroleverytimethatPivotTable1isrefreshed.

SubPivotTable1_CommandExecute(Command,Succeeded)

DimptConstants

SetptConstants=PivotTable1.Constants

'ChecktoseeifthePivotTablelisthasbeenrefreshed.IfCommand=ptConstants.plCommandRefreshThen

'Writethecurrentdataandtimetothetextbox.TextBox.Value="PivotTableLastRefeshedon"&_Date&"at"&Time

EndIf

EndSub

CommandTipTextEvent

OccurswhenthethespecifiedMicrosoftOfficeWebComponentqueriesacommand'sScreenTiptext.

PrivateSubobject_CommandTipText(ByValCommandAsVariant,ByValCaptionAsByRef)

objectAChartSpace,PivotTable,orSpreadsheetobject.

CommandThecommandthathasbeenexecuted.

CaptionTheValuepropertyofthisobjectcontainstheScreenTiptextforthecommand.

RemarksTheOCCommandId,ChartCommandIdEnum,PivotCommandId,andSpreadsheetCommandIdconstantscontainlistsofthesupportedcommandsforeachWebcomponent.

CurrentEvent

Occurswhenarecordbecomesthecurrentrecord.

PrivateSubObject_Current(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

ShowAll

DataChangeEvent

Occurswhencertainpropertiesarechangedorwhencertainmethodsareexecuted.SeethePivotDataReasonEnumconstantformoreinformationaboutthepropertiesandmethodsthatcantriggerthisevent.

PrivateSubObject_DataChange(ByValReasonAsPivotDataReasonEnum)

ObjectThenameofthePivotTableobjectthatyouaretrappingthiseventfor.

ReasonUsethevalueofthePivotDataReasonEnumconstanttodeterminethereasonthatthiseventwastriggered.

DataErrorEvent

Occurswheneveradataerroroccurs.

PrivateSubObject_DataError(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

DataPageCompleteEvent

Occurswhenthespecifieddataaccesspagefinishesloading.

PrivateSubObject_DataPageComplete(DSCEventInfoAsDSCEVENTINFO)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

DataSetChangeEvent

Occurswheneverachartworkspaceisdata-boundandthedatasetchanges—forexample,whenafilteroperationtakesplace.Thiseventalsooccurswheninitialdataisavailablefromthedatasource.

PrivateSubObject_DataSetChange()

ObjectThenameoftheChartSpaceobjectthatthiseventappliesto.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

DblClickEvent

Occurswhenevertheuserdouble-clicksthespecifiedcontrol.

PrivateSubobject_DblClick()

objectAChartSpace,PivotTable,orSpreadsheetobject.

DirtyEvent

Occurswhenthecontentsofadataaccesspagearechangedbytheuser.

PrivateSubObject_Dirty(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksSettheReturnValuepropertyoftheDSCEventInfoobjecttoFalsetorestorethepreviousvalue.

UsetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttodeterminethedataaccesspage,section,andrecordsetthatwasupdated.

ThiseventfiresbeforetheBeforeUpdateevent.

EndEditEvent

OccurswhenevertheuserswitchesfromeditmodeonthespecifiedSpreadsheetControlorPivotTablelist.YoucanusethiseventtovalidatedataentryinaworksheetorinthedetailareaofaPivotTablelist.

PrivateSubObject_EndEdit(ByValAcceptAsBoolean,ByValFinalValueAsByRef,ByValCancelAsByRef,ByValErrorDescriptionAsByRef)

ObjectAPivotTableorSpreadsheetobject.

AcceptSpecifieswhetherornotthespecifiedcontrolisacceptingtheedit.IfthisargumentisFalse,thenthecontrolisleavingeditmodebecausetheusercancelledtheedit.IfthisargumentisTrue,thenyoucancanceltheedit.

FinalValueTheValuepropertyofthisargumentreturnsthevaluethatistobeenteredintotheworksheetorPivotTablelist.

CancelSettheValuepropertyofthisargumenttoTruetocanceltheeditandleavetheuserineditmode.

ErrorDescriptionSettheValuepropertyofthisargumenttothetextthatyouwanttodisplaytotheuser.Thedefaulttextis"Thenewvaluewasnotaccepted.".

FocusEvent

Occurswhenasectioninadataaccesspagereceivesfocus.

PrivateSubObject_Focus(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksUsetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttodeterminethedataaccesspage,section,andrecordsetthatwasupdated.

InitializeEvent

OccurswhentheSpreadsheetComponentisloading,butbeforeitisloadedcompletely.

PrivateSubObject_Initialize()

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

RemarksUsethiseventtoinitializethesettingsforthespreadsheet.

ExampleThisexampleusestheInitializeeventtosetthespreadsheetdatafromafileontheuser'scomputer.

SubSpreadsheet1_Initialize()

'LoadaCSVfileintothespreadsheet.Spreadsheet1.CSVURL="Data.csv"

EndSub

KeyDownEvent

Occurswhenevertheuserpressesakeyonthekeyboard.Iftheuserholdsthekeydown,thiseventrepeatsitselfatthekey-repeatintervalthathasbeensetontheuser’scomputer.

PrivateSubObject_KeyDown(ByValKeyCodeAsLong,ByValShiftAsLong)

ObjectThenameoftheChartSpace,PivotTableorSpreadsheetobjectthatyouaretrappingthiseventfor.

KeyCodeALongthatrepresentsthekeycodeofthekeythatwaspressedorreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeys.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,and4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,norALTkeyswerepressed.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

Thesequenceofkeyboard-relatedeventsis:

1. BeforeKeyDown

2. KeyDown

3. BeforeKeyPress

4. KeyPress

5. BeforeKeyUp

6. KeyUp

KeyPressEvent

Occurswhenevertheuserpressesandreleasesakeyonthekeyboard.

PrivateSubObject_KeyPress(ByValKeyAsciiAsLong)

ObjectThenameoftheChartSpace,PivotTableorSpreadsheetobjectthatyouaretrappingthiseventfor.

KeyAsciiALongthatrepresentsthekeycodeofthekeythatwaspressedorreleased.

RemarksThiseventwillnotbecallediftheBeforeKeyDowneventiscancelled.

ForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

Thesequenceofkeyboard-relatedeventsis:

1. BeforeKeyDown

2. KeyDown

3. BeforeKeyPress

4. KeyPress

5. BeforeKeyUp

6. KeyUp

KeyUpEvent

Occurswhenevertheuserreleasesakeyonthekeyboard.

PrivateSubObject_KeyUp(ByValKeyCodeAsLong,ByValShiftAsLong)

ObjectThenameoftheChartSpace,PivotTableorSpreadsheetobjectthatyouaretrappingthiseventfor.

KeyCodeALongthatrepresentsthekeycodeofthekeythatwaspressedorreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeys.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,and4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,norALTkeyswerepressed.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

Thesequenceofkeyboard-relatedeventsis:

1. BeforeKeyDown

2. KeyDown

3. BeforeKeyPress

4. KeyPress

5. BeforeKeyUp

6. KeyUp

LoadCompletedEvent

OccurswhentheSpreadsheetComponenthascompletedloading.

PrivateSubObject_LoadCompleted()

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

MouseDownEvent

Occurswhenevertheuserpressesamousebuttonwhilethepointerispositionedoverthespreadsheet,PivotTablelist,orthechartworkspace.

PrivateSubObject_MouseDown(ByValButtonAsLong,ByValShiftAsLong,ByValxAsLong,ByValyAsLong)

ObjectThenameoftheChartSpace,PivotTableorSpreadsheetobjectthatyouaretrappingthiseventfor.

ButtonThemousebuttonthatwasreleased.Returns1iftheprimarymousebuttonwasreleased,2ifthesecondarymousebuttonwasreleased,or4ifthemiddlemousebuttonwasreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeyswhentheeventoccurred.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,or4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,norALTkeyswerepressed.

xTheXcoordinateofthemousepointer.

yTheYcoordinateofthemousepointer.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

MouseMoveEvent

OccurswhenevertheusermovesthemousepointeroverthePivotTablelistorthechartworkspace.

PrivateSubObject_MouseMove(ByValButtonAsLong,ByValShiftAsLong,ByValxAsLong,ByValyAsLong)

ObjectThenameoftheChartSpaceorPivotTableobjectthatyouaretrappingthiseventfor.

ButtonThemousebuttonthatwasreleased.Returns1iftheprimarymousebuttonwasreleased,2ifthesecondarymousebuttonwasreleased,or4ifthemiddlemousebuttonwasreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeyswhentheeventoccurred.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,or4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,norALTkeyswerepressed.

xTheXcoordinateofthemousepointer.

yTheYcoordinateofthemousepointer.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

MouseOutEvent

Occurswhenevertheusermovesthemousepointeroutofacellonaspreadsheet.

PrivateSubObject_MouseOut(ByValButtonAsLong,ByValShiftAsLong,ByValTargetAsRange)

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

ButtonThemousebuttonthatwasreleased.Returns1iftheprimarymousebuttonwasreleased,2ifthesecondarymousebuttonwasreleased,or4ifthemiddlemousebuttonwasreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeys.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,or4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,norALTkeyswerepressed.

TargetARangeobjectthatrepresentsthecellorcellsthatthemousepointerwasmovedoutof.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

MouseOverEvent

Occurswhenevertheusermovesthemousepointeroveracellonthespecifiedspreadsheet.

PrivateSubObject_MouseOut(ByValButtonAsLong,ByValShiftAsLong,ByValTargetAsRange)

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

ButtonThemousebuttonthatwasreleased.Returns1iftheprimarymousebuttonwasreleased,2ifthesecondarymousebuttonwasreleased,or4ifthemiddlemousebuttonwasreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeys.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,or4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,norALTkeyswerepressed.

TargetARangeobjectthatrepresentsthecellorcellsthatthemousepointerwasmovedover.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

MouseUpEvent

Occurswhenevertheuserreleasesamousebuttonwhilethepointerispositionedoverthespreadsheet,PivotTablelist,orthechartworkspace.

PrivateSubObject_MouseUp(ByValButtonAsLong,ByValShiftAsLong,ByValxAsLong,ByValyAsLong)

ObjectThenameoftheChartSpace,PivotTableorSpreadsheetobjectthatyouaretrappingthiseventfor.

ButtonThemousebuttonthatwasreleased.Returns1iftheprimarymousebuttonwasreleased,2ifthesecondarymousebuttonwasreleased,4ifthemiddlemousebuttonwasreleased.

ShiftThestateoftheSHIFT,CTRL,andALTkeyswhentheeventoccurred.Returns1iftheSHIFTkeywaspressed,2iftheCTRLkeywaspressed,and4iftheALTkeywaspressed.Returns0ifneithertheSHIFT,CTRL,norALTkeyswerepressed.

xThexcoordinateofthemousepointer.

yTheycoordinateofthemousepointer.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

MouseWheelEvent

Occurswhentheuserrotatesthemousewheelonamousedevicethathasawheel.

PrivateSubObject_MouseWheel(ByValPageAsBoolean,ByValCountAsLong)

ObjectThenameoftheChartSpace,PivotTable,orSpreadsheetobjectthatyouaretrappingthiseventfor.

PageReturnsTrueifthepagewaschanged.

CountThenumberoflinesthatwerescrolled.

ParametersOutReadyEvent

TheParametersOutReadyeventoccurswhenasetofparametersispassedfromaconnectedWebPartthatimplementstheIParametersOutProviderinterfacetoaSpreadsheetWebPartthatimplementstheIParametersOutConsumerinterface.

expression.ParametersOutReady(InterfaceNameAsString,ParamValuesAsVariant)

expressionRequired.AnexpressionthatreturnsaSpreadsheetobject.

InterfaceNameThenameoftheIParametersOutConsumerinterfacereceivingtheevent(asdefinedinthesolutionspecificationfile:InterfaceConnections/ParametersOutConsumer@Name).

ParamValuesAnarrayofstringsthatcontainstheparametersprovidedbytheWebPartimplementingtheIParametersOutProviderinterface.

Remarks

ThiseventappliesonlytoaSpreadsheetWebPartonaWebPartPageonaSharePointsite.FormoreinformationontheSpreadsheetWebPart,searchExcelhelpandtheMicrosoftDeveloperNetwork(MSDN)Website.

TheParametersOutReadyeventfireswhenaseparateWebPartthatimplementstheIParametersOutProviderinterfaceinvokestheFireParametersOutmethod.TheParamValuesparameterisanarrayofstringsinwhicheachstringcontainsthevalueofaparameter.TheParamValuesparametermusthavethesamelengthandorderastheitemslistedintheIParametersOutProviderinterfacedeclaration.Whenthiseventfires,youcanquerytheWebPartdatasourcetogettheupdateddatathathasbeensenttothedatasourcebytheWebPartthatimplementstheIParametersOutProviderinterface.

ShowAll

PivotTableChangeEvent

OccurswheneveraPivotTablelistfield,fieldset,ortotalisaddedordeleted.

PrivateSubPivotTable_PivotTableChange(ReasonAsPivotTableReasonEnum)

ReasonSpecifieshowthePivotTablelistchanged.CanbeoneofthePivotTableReasonEnumconstants.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

QueryEvent

OccurswheneveraPivotTablelistquerybecomesnecessary.Thequerymaynotoccurimmediately;itmaybedelayeduntilthenewdataisdisplayed.

PrivateSubPivotTable_Query()

RecordExitEvent

Occurswhentheusernavigatestoanotherrecord,refreshethedataaccesspage,orclosesthedataaccesspage.

PrivateSubObject_RecordExit(DSCEventInfoAsDSCEventInfo)

ObjectThenameoftheDataSourceControlobjectthatthiseventappliesto.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksThiseventoccursaftertheBeforeUpdateevent,butbeforetherecordischanged.

Inthecaseofabandeddataaccesspage,movingamongchildrecordsforthesameparentdoesnotfirethisevent.

SettingtheReturnValuepropertyoftheDSCEventInfoobjecttoFalsecancelsthiseventandpreventstherecordfrombeingchanged.

UsetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttodeterminethedataaccesspage,section,andrecordsetthatwasupdated.

RecordsetSaveProgressEvent

OccursrepeatedlywhentheExportXMLmethodiscalled.Usethiseventtoprovidefeedbacktotheuserwhenarecordsetisexported.

PrivateSubObject_RecordsetSaveProgress(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksUsethePercentCompletepropertytodeterminethecurrentprogressoftheexportoperation.

YoucannotusethiseventtoupdatethecontentsofthecurrentHTMLdocument.

ExampleThisexampleusestheRecordsetSaveProgesseventtoupdateMicrosoftInternetExplorer'sstatusbarwhentherecordsetcontainedbytheDataSourceControlissaved.

SubMSODSC_RecordsetSaveProgress(DSCEventInfo)

'Updatethestatusbarwiththecurrent'completionpercentage.Window.Status=DSCEventInfo.PercentComplete

'Checktoseeifthesavehasbeencompleted.IfDSCEventInfo.PercentComplete=100then

'Clearthestatusbarwhenthesaveiscomplete.Window.Status=""EndIf

EndSub

RowReadyEvent

TheRowReadyeventprocedureoftheSpreadsheetcomponentiscalledwhenaListObjectobjectisloadedintothecomponent,whenasinglerowinaListObjectobjectisselected,andwhentheRefreshmethodoftheXmlDataBindingobjectiscalled,regardlessofthesuccessorfailureofthatmethod.

PrivateSubSpreadsheet1_RowReady(XDTNameAsString,RowDataArrayAsVariant,SelectionStatusAsString)

XDTNameContainsthevalueoftheNamepropertyoftheListObjectobject.

RowDataArrayThisparametercontainsanarrayofvaluesfromeachcellintheselectedrowwhenSelectionStatusreturns"Standard".ThearraywillbeemptywhenSelectionStatusreturns"New"or"None".

SelectionStatusContainsoneofthevaluesdescribedinthefollowingtable:

Value DescriptionNew Indicatesthatthenew,orinsertrow,isselected.Thearrayof

valuesinRowDataArraywillbeempty.None Indicatesthatnorowisselected.Thearrayofvaluesin

RowDataArraywillbeempty.Standard Indicatesthatanexistingrowisselected.Thearrayofvalues

inRowDataArraycontainvaluesfromeachcellintheselectedrow.

Remarks

IfthiseventfiresasaresultofloadinganewXMLSpreadsheetfileorXMLdataintothecontrol,thevalueoftheSelectionStatusparameterwillbe"None".TheSpreadsheetcomponentwillfiretheRowReadyeventanytimetheactivecellismovedtoadifferentrowinalist.TheRowReadyeventwillnotfireifauserclickswithinaselectedrow,orclicksoutsideofthelist,andthenselectsmultiplerowswithinthelist.

ExampleThefollowingexampleusestheRowReadyeventproceduretoworkwiththeinformationcontainedintheeventprocedureparameters:

SubSpreadsheet1_RowReady(XDTName,RowDataArray,SelectionStatus)DimstrCellDataDimintItem

SelectCaseSelectionStatus Case"None" Case"New" Case"Standard" ForintItem=0toUBound(RowDataArray)-1 strCellData=RowDataArray(intItem)'Workwithdataincellsofselectedrowhere. NextCaseElse EndSelectEndSub

SelectionChangeEvent

Occurswhenevertheusermakesanewselection.Theusercannotcancelthisevent.

PrivateSubObject_SelectionChange()

ObjectThenameoftheChartSpace,PivotTable,orSpreadsheetobjectthatthiseventappliesto.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

YoucanusetheSelectionpropertytodeterminetheobjecttypeofthecurrentselection,asshowninthefollowingexample.

PrivateSubPivotTable_SelectionChange()IfTypeName(PivotTable.Selection)="PivotTotal"Then'HandleselectionofatotalhereEndIfEndSub

SelectionChangingEvent

Occurswhenevertheusermovesthemousepointerwhileselectingarange.Thiseventdoesnotoccurwhentheuserselectsarangebyusingthekeyboard.Theusercannotcancelthisevent.

PrivateSubObject_SelectionChanging(ByValRangeAsRange)

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

RangeARangeobjectthatrepresentstherangeofcellsthatarebeingselected.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

SheetActivateEvent

Occurswhenaworksheetisactivated.

PrivateSubObject_SheetActivate(ByValShAsWorksheet)

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

ShRequiredWorksheet.Theworksheetthathasbeenactivated.

RemarksWhenauserchangesworksheets,theSheetDeactivateeventiscalledbeforetheSheetActivateevent.

ExampleThisexampledisplaysthenameoftheactivatedworksheeteachtimethataworksheetisactivatedinSpreadsheet1.

SubSpreadsheet1_SheetActivate(Sh)

MsgBoxSh.Name

EndSub

SheetCalculateEvent

Occursafteranyworksheethasbeencalculated.

PrivateSubObject_SheetCalculate(ByValShAsWorksheet)

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

ShAWorksheetobjectthatrepresentstheworksheetthatwascalculated.

ExampleThisexampleusestheSheetCalculateeventtomonitorthestatusofthevalueincellA5inSheet1ofSpreadsheet1.

SubSpreadsheet1_SheetCalculate(Sh)

DimrngRangeToWatch

'Setavariabletothecellthatyouwanttowatch.SetrngRangeToWatch=Spreadsheet1.Worksheets("Sheet1").Range("A5")

'IfthecalculatedsheetisSheet1...IfSh.Name="Sheet1"Then

'...andthevalueofthecelltowatchislessthant10...IfrngRangeToWatch.Value<10Then

'...alerttheuserofthestatus.MsgBox"Inventoryislessthan10.Reorderthepart."EndIf

EndIf

EndSub

SheetChangeEvent

Occurswhencellsinanyworksheetarechangedbytheuserorbyanexternallink.

PrivateSubObject_SheetChange(ByValShAsObject,ByValTargetAsRange)

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

ShAWorksheetobjectthatrepresentsthesheet.

TargetARangeobjectthatrepresentsthechangedrange.

ExampleThisexampleillustrateshowtousetheSheetChangeeventtoperformconditionalformattingoncellsA1:10inSheet1ofSpreadsheet1.

SubSpreadsheet1_SheetChange(Sh,Target)DimrngIntersectDimrngCondFormat

'Setavariabletotherangetobeconditionallyformatted.Inthis'case,therangeiscellsA1:A10onSheet1.SetrngCondFormat=Spreadsheet1.Worksheets("Sheet1").Range("A1:A10")

'ChecktoseeifthechangewasmadeonSheet1.IfSh.Name="Sheet1"Then

'Setavariabletotheintersectionofthechangedcell'andtheconditionalformattingrange.SetrngIntersect=Spreadsheet1.RectIntersect(Target,rngCondFormat)

'Checktoseeifthechangedcellintersectswiththe'conditionalformattingrange.IfNotrngIntersectIsNothingThen

'Formatthetargetcellbasedonitsvalue.SelectCaseTarget.Value

CaseIs>=25Target.Font.Color="Green"Target.Font.Bold=TrueTarget.Font.Italic=FalseCaseIs>=10

Target.Font.Color="Blue"Target.Font.Bold=FalseTarget.Font.Italic=TrueCaseIs<10Target.Font.Color="Red"Target.Font.Bold=TrueTarget.Font.Italic=FalseEndSelectEndIfEndIfEndSub

SheetDeactivateEvent

Occurswhenaworksheetisdeactivated.

PrivateSubObject_SheetDeactivate(ByValShAsWorksheet)

ObjectThenameoftheSpreadsheetobjectthatyouaretrappingthiseventfor.

ShRequiredWorksheet.Theworksheetthathasbeendeactivated.

RemarksWhenauserchangesworksheets,thiseventiscalledbeforetheSheetActivateevent.

ExampleThisexampledisplaysthenameofthedeactivatedworksheeteachtimethataworksheetisdeactivatedinSpreadsheet1.

SubSpreadsheet1_SheetDeactivate(Sh)

MsgBoxSh.Name&"wasjustdeactivated."

EndSub

SheetFollowHyperlinkEvent

Occurswhenahyperlinkisclicked.

PrivateSubobject_SheetFollowHyperlink(ByValShAsWorksheet,TargetAsHyperlink)

objectRequired.ThenameofaSpreadsheetobjectthatyouaretrappingthiseventfor.

ShRequired.Theworksheetthathasbeendeactivated.

TargetRequired.Thehyperlinkthathasbeenclicked.

ExampleThisexamplekeepsalogofhyperlinksclickedinSpreadsheet1.ThenameofthesheetcontainingthehyperlinkandthetargetaddressarewrittentoSheet3eachtimethatahyperlinkisclicked.

SubSpreadsheet1_SheetFollowHyperlink(Sh,Target)

DimssConstantsDimrngNewItemDimshtListSheet

SetssConstants=Spreadsheet1.Constants

'SetavariabletoSheet3.SetshtListSheet=Spreadsheet1.ActiveWorkbook.Worksheets("Sheet3")

'SetavariabletothefirstavailablecellincolumnAofSheet3.SetrngNewItem=shtListSheet.Range("A262144").End(ssConstants.xlUp).Offset(1,0)

'WritethenameofthesheettoColumnAofSheet3.rngNewItem.Value=Sh.Name

'WritethetargetaddressofthehyperlinktoColumnBofSheet3.rngNewItem.Offset(0,1).Value=Target.Address

EndSub

ShowAll

StartEditEvent

StartEditeventasitappliestotheSpreadsheetobject.

StartEditEventasitappliestothePivotTableobject.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

UndoEvent

OccurswhentheuserclickstheUndobuttononthenavigationcontrol,ortheDirtyeventiscanceled.Thiseventfiresbeforethedataisreturnedtoitsoriginalvalues.Usethiseventtosettheconditionsunderwhichtheuserisallowedtoundoachange.

PrivateSubObject_Undo(ByValDSCEventInfoAsDSCEventInfo)

ObjectADataSourceControlobject.

DSCEventInfoTheDSCEventInfoobjectthatcontainsinformationabouttheevent.

RemarksSettheReturnValuepropertyoftheDSCEventInfoobjecttoFalsetocanceltheundoaction.

YoucanusetheDataPageandSectionpropertiesoftheDSCEventInfoobjecttogetmoreinformationaboutthepage.

ShowAll

ViewChangeEvent

ViewChangeeventasitappliestotheChartSpaceobject.

ViewChangeeventasitappliestothePivotTableobject.

ViewChangeeventasitappliestotheSpreadsheetobject.

RemarksForinformationaboutusingeventswithVBScript,seeDeclaringandUsingEventProceduresinVBScript.

ShowAll

OfficeWebComponentsConstants

ThistopicprovidesalistofallconstantsintheOfficeWebComponentsobjectmodel.Forinformationonhowtousetheseconstants,seeUsingNamedConstantsinVBScript.

AddinClientTypeEnum

BindingLoadMode

Chart3DSurfaceEnum

ChartAxisCrossesEnum

ChartAxisGroupingEnum

ChartAxisPositionEnum

ChartAxisTypeEnum

ChartAxisUnitTypeEnum

ChartBoundaryValueTypeEnum

ChartChartLayoutEnum

ChartChartTypeEnum

ChartColorIndexEnum

ChartCommandIdEnum

ChartDataGroupingFunctionEnum

ChartDataLabelPositionEnum

ChartDataPointEnum

ChartDataSourceTypeEnum

ChartDimensionsEnum

ChartDrawModesEnum

ChartDropZonesEnum

ChartEndStyleEnum

ChartErrorBarCustomValuesEnum

ChartErrorBarDirectionEnum

ChartErrorBarIncludeEnum

ChartErrorBarTypeEnum

ChartFillStyleEnum

ChartFillTypeEnum

ChartGradientStyleEnum

ChartGradientVariantEnum

ChartGroupingTotalFunctionEnum

ChartLabelOrientationEnum

ChartLegendPositionEnum

ChartLineDashStyleEnum

ChartLineMiterEnum

ChartMarkerStyleEnum

ChartPatternTypeEnum

ChartPivotDataReferenceEnum

ChartPlotAggregatesEnum

ChartPresetGradientTypeEnum

ChartPresetTextureEnum

ChartProjectionModeEnum

ChartScaleOrientationEnum

ChartScaleTypeEnum

ChartSelectionMarksEnum

ChartSelectionsEnum

ChartSelectMode

ChartSeriesByEnum

ChartSizeRepresentsEnum

ChartSpecialDataSourcesEnum

ChartTextureFormatEnum

ChartTexturePlacementEnum

ChartTickMarkEnum

ChartTitlePositionEnum

ChartTrendlineTypeEnum

DefaultControlTypeEnum

DscAdviseTypeEnum

DscDisplayAlert

DscDropLocationEnum

DscDropTypeEnum

DscEncodingEnum

DscFetchTypeEnum

DscFieldTypeEnum

DscGroupOnEnum

DscHyperlinkPartEnum

DscJoinTypeEnum

DscLocationEnum

DscObjectTypeEnum

DscOfflineTypeEnum

DscPageRelTypeEnum

DscRecordsetTypeEnum

DscRowsourceTypeEnum

DscSaveAsEnum

DscStatusEnum

DscTotalTypeEnum

DscXMLLocationEnum

ExpandBitmapTypeEnum

LineStyleEnum

LineWeightEnum

MsoAppLanguageID

MsoLanguageID

NavButtonEnum

NotificationType

OCCommandId

PivotArrowModeEnum

PivotCaretPositionEnum

PivotCommandId

PivotDataReasonEnum

PivotEditModeEnum

PivotExportActionEnum

PivotFieldFilterFunctionEnum

PivotFieldGroupOnEnum

PivotFieldSetAllIncludeExcludeEnum

PivotFieldSetOrientationEnum

PivotFieldSetTypeEnum

PivotFieldSortDirectionEnum

PivotFieldTypeEnum

PivotFilterUpdateMemberStateEnum

PivotHAlignmentEnum

PivotMemberCustomGroupTypeEnum

PivotMemberFindFormatEnum

PivotMemberPropertyDisplayEnum

PivotMembersCompareByEnum

PivotScrollTypeEnum

PivotShowAsEnum

PivotTableExpandEnum

PivotTableReasonEnum

PivotTotalFunctionEnum

PivotTotalTypeEnum

PivotViewReasonEnum

PivotViewTotalOrientationEnum

ProviderType

SectTypeEnum

SheetCommandEnum

SheetExportActionEnum

SheetExportFormat

SheetFilterFunction

SpreadSheetCommandId

SynchronizationStatus

TipTypeEnum

UnderlineStyleEnum

XlApplicationInternational

XlBordersIndex

XlBorderWeight

XlCalculation

XlColorIndex

XlConstants

XlDeleteShiftDirection

XlDirection

XlFindLookIn

XlHAlign

XlInsertShiftDirection

XlLineStyle

XlLookAt

XlOrientation

XlRangeValueType

XlReadingOrder

XlReferenceStyle

XlSearchDirection

XlSearchOrder

XlSheetType

XlSheetVisibility

XlSortOrder

XlUnderlineStyle

XlVAlign

XlWindowType

XlYesNoGuess

TrendlinesProperty

ReturnstheChTrendlinescollectionforthespecifiedseries.Notethataseriescanhaveonlyonetrendline.

expression.Trendlines

expressionRequired.AnexpressionthatreturnsaChSeriesobject.

RemarksForinformationaboutreturningasinglememberofacollection,seeReturninganObjectfromaCollection.

ExampleThisexampleaddsatrendlinetothespecifiedseriesandthenhidesthetrendline’sR-squaredvalue.

SubAddTrendline()

DimserSeries1

'SetavariabletothefirstseriesinthefirstchartofChartspace1.SetserSeries1=ChartSpace1.Charts(0).SeriesCollection(0)

'Addatrendlinetotheseries.serSeries1.Trendlines.Add

'HidetheRSquaredvalueforthetrendline.serSeries1.Trendlines(0).IsDisplayingRSquared=False

EndSub

HasChartSpaceLegendProperty

Trueifthespecifiedchartworkspacehasalegend.Read/writeBoolean.

expression.HasChartSpaceLegend

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksSettingthispropertytoFalsecausesthelegendtobedeletedfromthechartworkspace.Whenthishappens,allcustomformattingislostandmustberesetifthepropertyissubsequentlysettoTrue.

ExampleThisexamplesetsthechartworkspacetitleandpositionsthechartworkspacelegendontheleftsideoftheworkspace.

SubFormat_ChartSpace()DimchConstantsSetchConstants=ChartSpace1.Constants'Enablethetitleforthechartspace.ChartSpace1.HasChartSpaceTitle=True

'Setthechartspacetitle.ChartSpace1.ChartSpaceTitle.Caption="MonthlySalesData"'Enablethelegendforthechartspace.ChartSpace1.HasChartSpaceLegend=True

'Specifythepositionofthechartspacelegend.ChartSpace1.ChartSpaceLegend.Position=chConstants.chLegendPositionLeftEndSub

ChartSpaceLegendProperty

ReturnsaChLegendobjectthatrepresentsthechartworkspacelegend.Usethispropertytosetthepropertiesforthechartworkspacelegend.NotethattheChartSpaceLegendpropertyrepresentsthelegendfortheentirechartworkspace.UsetheLegendpropertyoftheChChartobjecttosetthelegendforindividualchartswithinthechartworkspace.ReturnsNothingifthechartworkspacedoesnothavealegend.Read-only.

expression.ChartSpaceLegend

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ExampleThisexamplesetsthechartworkspacetitleandpositionsthechartworkspacelegendontheleftsideoftheworkspace.

SubSetLegend()DimchConstantsSetchConstants=ChartSpace1.Constants'Enablethetitleforthechartworkspace.ChartSpace1.HasChartSpaceTitle=True'Setthetitleforthechartworkspace.ChartSpace1.ChartSpaceTitle.Caption="MonthlySalesData"'Enablethelegendforthechartworkspace.ChartSpace1.HasChartSpaceLegend=True'Positionthelegendforthechartworkspace.ChartSpace1.ChartSpaceLegend.Position=chConstants.chLegendPositionLeftEndSub

HasChartSpaceTitleProperty

Trueifthespecifiedchartworkspacehasatitle.Read/writeBoolean.

expression.HasChartSpaceTitle

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

RemarksSettingthispropertytoFalsecausesthetitletobedeletedfromthechartworkspace.Whenthishappens,allcustomformattingislostandmustberesetifthepropertyissubsequentlysettoTrue.

ExampleThisexamplesetsthechartworkspacetitleandpositionsthechartworkspacelegendontheleftsideoftheworkspace.

SubFormat_ChartSpace()DimchConstantsSetchConstants=ChartSpace1.Constants'Enablethetitleforthechartspace.ChartSpace1.HasChartSpaceTitle=True

'Setthechartspacetitle.ChartSpace1.ChartSpaceTitle.Caption="MonthlySalesData"'Enablethelegendforthechartspace.ChartSpace1.HasChartSpaceLegend=True

'Specifythepositionofthechartspacelegend.ChartSpace1.ChartSpaceLegend.Position=chConstants.chLegendPositionLeftEndSub

ChartSpaceTitleProperty

ReturnsaChTitleobjectthatrepresentsthechartworkspacetitle.Usethispropertytosetthepropertiesforthechartworkspacetitle.NotethattheChartSpaceTitlepropertyrepresentsthetitlefortheentirechartworkspace.UsetheTitlepropertyoftheChChartobjecttosetthetitleforindividualchartswithinthechartworkspace.ReturnsNothingifthechartworkspacedoesnothaveatitle.Read-only.

expression.ChartSpaceTitle

expressionRequired.AnexpressionthatreturnsaChartSpaceobject.

ExampleThisexamplesetsthechartworkspacetitleandpositionsthechartworkspacelegendontheleftsideoftheworkspace.

SubSetLegend()DimchConstantsSetchConstants=ChartSpace1.Constants'Enablethetitleforthechartworkspace.ChartSpace1.HasChartSpaceTitle=True'Setthetitleforthechartworkspace.ChartSpace1.ChartSpaceTitle.Caption="MonthlySalesData"'Enablethelegendforthechartworkspace.ChartSpace1.HasChartSpaceLegend=True'Positionthelegendforthechartworkspace.ChartSpace1.ChartSpaceLegend.Position=chConstants.chLegendPositionLeftEndSub

XProperty

ReturnsaLongthatrepresentstheX-coordinateofthedatapointcurrentlystoredintheCoordinateobject.Read-only.

expression.x

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksUsetheValueToPointmethodtoreturnthecoordinatesofadatapointtoaCoordinateobject.

UsetheypropertytoreturntheY-coordinateofthedatapointcurrentlystoredintheCoordinateobject.

ExampleThisexamplechangesthetitleofthefirstchartinChartspace1tothepixelcoordinatesofadatapointinthefirstseriesofthechart.

SubGetPixelCoordinates()

DimchChart1DimlXPosDimlYPosDimcoPointCoordinates

'SetavariabletothefirstchartinChartspace1.SetchChart1=ChartSpace1.Charts(0)

'Enablethetitleforthechart.chChart1.HasTitle=True

'SetaCoordinateobjecttothecoordinatesofadatapoint.SetcoPointCoordinates=chChart1.SeriesCollection(0).ValueToPoint("Pears",10)

'SetavariabletotheX-coordinate.lXPos=coPointCoordinates.x

'SetavariabletotheY-coordinate.lYPos=coPointCoordinates.y

'Setthechart'stitlestothepixelcoordinatesofthespecified'datapoint.chChart1.Title.Caption="X("&lXPos&")Y("&lYPos&")"

EndSub

YProperty

ReturnsaLongthatrepresentstheYcoordinateofthedatapointcurrentlystoredintheCoordinateobject.Read-only.

expression.y

expressionRequired.AnexpressionthatreturnsoneoftheobjectsintheAppliesTolist.

RemarksUsetheValueToPointmethodtoreturnthecoordinatesofadatapointtoaCoordinateobject.

UsethexpropertytoreturntheXcoordinateofthedatapointcurrentlystoredintheCoordinateobject.

ExampleThisexamplechangesthetitleofthefirstchartinChartspace1tothepixelcoordinatesofadatapointinthefirstseriesofthechart.

SubGetPixelCoordinates()

DimchChart1DimlXPosDimlYPosDimcoPointCoordinates

'SetavariabletothefirstchartinChartspace1.SetchChart1=ChartSpace1.Charts(0)

'Enablethetitleforthechart.chChart1.HasTitle=True

'SetaCoordinateobjecttothecoordinatesofadatapoint.SetcoPointCoordinates=chChart1.SeriesCollection(0).ValueToPoint("Pears",10)

'SetavariabletotheX-coordinate.lXPos=coPointCoordinates.x

'SetavariabletotheY-coordinate.lYPos=coPointCoordinates.y

'Setthechart'stitlestothepixelcoordinatesofthespecified'datapoint.chChart1.Title.Caption="X("&lXPos&")Y("&lYPos&")"

EndSub

ReturninganObjectfromaCollection

TheItempropertyreturnsasingleobjectfromacollection.ThefollowingexamplesetsthevariablethisCharttoaChChartobjectthatrepresentschartone.

SetthisChart=ChartWorkspace1.Charts.Item(1)

TheItempropertyisthedefaultpropertyformostcollections,soyoucanwritethesamestatementmoreconciselybyomittingtheItemkeyword.

SetthisChart=ChartWorkspace1.Charts(1)

SomecollectionsuseanenumeratedtypewiththeirItempropertytoreturnspecificmembersofthecollection.Forexample,theChAxescollectionusestheChartAxisPositionEnumenumeratedtype,asshowninthefollowingexample.

SetchConstants=ChartSpace1.ConstantsSetvalueAxis=ChartSpace1.Charts(0).Axes.Item(chConstants.chAxisPositionLeft)SetcategoryAxis=ChartSpace1.Charts(0).Axes.Item(chConstants.chAxisPositionBottom)

Again,youcanomittheItemkeyword,asshowninthefollowingexample.

SetchConstants=ChartSpace1.ConstantsSetvalueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionLeft)SetcategoryAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionBottom)

Formoreinformationaboutaspecificcollection,seetheHelptopicforthatcollection.

UsingNamedConstantsinVBScript

YoucannotusenamedconstantsinVBScriptcode.ThefollowingexampleworksinVisualBasicbutdoesnotworkinVBScript.

SetvalueAxis=ChartSpace1.Charts(0).Axes(chAxisPositionLeft)

VBScriptregardsthenamedconstantchAxisPositionLeftasjustanotheruninitializedvariable,soitsvalueis0(zero).BecausetheactualvalueofchAxisPositionLeftis–3,thiscodedoesnotworkasexpectedinVBScript.

TheConstantspropertyreturnsanobjectthatallowsVBScriptprogrammerstousenamedconstants.Thispropertyappliestoeachofthetop-levelcontainerobjects(ChartSpace,DataSourceControl,PivotTable,andSpreadsheet).ItreturnsanobjectthatcontainsallofthenamedconstantsavailableintheMicrosoftOfficeWebComponentstypelibrary(nomatterwhichobjecttheConstantspropertyisappliedto,italwaysreturnsthecompletesetofnamedconstants).

TousenamedconstantsinVBScript,youcansetanobjectvariabletotheobjectreturnedbytheConstantspropertyandthenusethatobjecttoqualifythenamedconstantsinyourcode,asshowninthefollowingexample.

SetchConstants=ChartSpace1.ConstantsSetvalueAxis=ChartSpace1.Charts(0).Axes(chConstants.chAxisPositionLeft)

YoucanalsousetheConstantspropertydirectlyinanexpression,asshowninthefollowingexample.

Spreadsheet1.ActiveSheet.Export"sstest.xls",Spreadsheet1.Constants.ssExportActionNone

NoteYoucanusetheConstantspropertyinVisualBasic,butitis

neitherrequirednorrecommended.UsingtheConstantspropertyincontainerswhereitisnotrequiredwillcauseyourcodetorunsignificantlyslower.

DeclaringandUsingEventProceduresinVBScript

YoudeclareeventproceduresinVisualBasicbyusingthePrivateandByValkeywordsandargumentswithexplicittypedeclarations,asshowninthefollowingexample.

PrivateSubSpreadsheet1_MouseOver(ByValButtonAsLong,ByValShiftAsLong,ByValTargetAsRange)

ThisproceduredeclarationwillnotworkinVBScriptbecauseVBScriptdoesnotusethesekeywordsandbecauseallargumentsarepassedasVariant.Instead,youdeclareeventproceduresinVBScriptsimplybyusingtheeventnameandargumentnames,asshowninthefollowingexample.

SubSpreadsheet1_MouseOver(Button,Shift,Target)

Theargumentnamesthemselvesaresimplyaconventioninanycontainer(youcoulduseanyargumentnames).

CautionSomescripteditors(includingMicrosoftScriptEditor)donotfillintheargumentlistwhentheycreateaneventprocedure.Toensurethatyoureventprocedurerunscorrectly,consulttheObjectBrowserortheappropriateeventtopicinHelp,andfillintheargumentlistyourself.