What’s New in FlexPro 10’s Object Model
The following sections include detailed information about all changes made to the FlexPro Object Model.
The changes in the FlexPro 10 Automation Object Model from the previous version mostly involve backward compatible extensions. The few changes that may require you to change your code are in red in the text below.
If you want to import macros or Automation code from FlexPro 6, FlexPro 7 or FlexPro 8 to FlexPro 10, you should first take a look at the required changes listed in What's New in FlexPro 7's Object Model, What's New in FlexPro 8's Object Model and What's New in FlexPro 9's Object Model.
Note You can obtain more information about the significant features of the listed objects, methods and properties by clicking on the links.
New objects
The FileIndexingService object represents the file indexing service.
The AnalysisDataSets collection represents the data set list of an analysis object.
The AnalysisDataSet object represents an entry added to the data set list of an analysis object.
The ListItemNames collection represents the list of list element names of a formula or analysis object.
The ListItemName object represents an entry in the list of formula or analysis object list element names.
The DataQueryItems collection represents the list of search items in a data query.
The DataQueryItem object represents an entry in the list of data query search items.
Changes to existing objects
The Application object has been expanded to include the FileIndexingService, which returns the object with the same name.
The Database object represents the project database and has been expanded to include the IndexingEnabled property.
The SearchWindow object represents the search window and has been expanded to include the UseSearchIndex property.
The FpObjectParameters collection represents the parameter list of any FlexPro object and has been expanded to include the Index property. You can use this to access a parameter by its name.
The FileDialog, FileDialogSelectedItems, FileDialogFilter and FileDialogFilters objects have been renamed due to conflicts with objects in Windows objects with the same name. The new names are: FpFileDialog, FpFileDialogSelectedItems, FpFileDialogFilter and FpFileDialogFilters. If you use this object in your code, you will need to change the code to include the new names.
In the FpObject object, which represents any FlexPro object, the Group property has been renamed to Category. The old name is still supported, but if you use this property in your code you should change the code to reflect the new name.
The ValueObject object represents a data object and has been expanded to include the Timestamp, TimestampY, TimestampX and TimestampZ properties.
The Formula object represents a formula and has been expanded to include the AssignHeader, ListItemNaming, ListItemNameTemplate and ListItemNames properties.
To support multichannel analyses, the analysis objects HistogramAnalysis, LinearInterpolationAnalysis, SignalSamplingAnalysis, EventIsolationAnalysis, SmoothAnalysis, ApproximationAnalysis, Approximation2DAnalysis, RegressionAnalysis, SignalCorrectionAnalysis, CurveTransformationAnalysis, SignalAnalysis, SignalScalingAnalysis, StatisticQuantityAnalysis, TimeFilterAnalysis, SplineAnalysis, SurfaceInterpolationAnalysis, ParametricSplineAnalysis, SingleCountAnalysis, RainflowCountAnalysis, CountMatrixAnalysis, GoodnessOfFitTestAnalysis, ConfidenceIntervalAnalysis, OutlierTestAnalysis, OutlierCorrectionAnalysis, VarianceTestAnalysis, SoundLevelAnalysis, SplineAnalysis, SplineAnalysis, SplineAnalysis, SplineAnalysis, SplineAnalysis, SplineAnalysis have been expanded to include the UseMultipleDataSets and DataSets properties.
The analysis objects CCFAnalysis, ConvolutionAnalysis and CompoundCountAnalysis have been expanded to include the UseMultipleDataSets1, UseMultipleDataSets2 as well as DataSets1 and DataSets2 properties.
The Folder object represents a folder and has been expanded to include the Value property, which return all the data sets within the folder as a list.
The Searchmethod of the Folder object has been expanded to include the UseSearchIndex argument, which can be used to specify whether the search index is to be used for the search. The order of the arguments has also been changed. You will have to change your code accordingly.
In the CursorObject and CursorProperties objects, the SynchronizeByIndex property has been replaced by the CursorSynchronizationMode property, which provides additional settings options. The old property is still supported, but if you use this property in your code you should change the code to use the new property. In addition, the CursorObject object has been expanded to include the CursorSynchronizationDataSet, and the CursorProperties object has been expanded to include the TimeDisplay property.
The FpCursor object, which represents a data cursor, and the Media object, which represents a medium, have been expanded to include the SeekToBeginning and SeekToEnd methods.
The SamplingRate property of the SignalSamplingAnalysis object has been renamed to SamplingInterval .
The properties PositionX, PositionY and PositionZ of the FpCursor object have been changed to the Variant data type.
The Markers collection has been expanded to include the FrameLineTransparency and BackgroundTransparency properties.
The DocObjectSelection object represents the markers in a document and has been expanded to include the MoveForward and MoveBackward methods.
The Axis2DScaling and Axis3DScaling objects represent the scaling of an axis in a 2D or 3D diagram and have been expanded to include the TimeDisplay method. The properties DivisionOrigin and AxisOrigin have been changed to the Variant data type.
The Curve2DFilling object represents the curve fill in a 2D diagram and has been expanded to include the Transparency property.
The Surface3DFilling object represents the 3D surface fill and has been expanded to include the Transparency property.
The Waterfall3DFilling object represents the 3D waterfall chart and has been expanded to include the Transparency property.
The CurveLabels object represents the curve data labels and has been expanded to include the BackgroundTransparency property.
The CurveLabel object represents the curve label and has been expanded to include the BackgroundTransparency property.
The SymbolInterior object and the Symbol3DInterior object represent the fill of a curve fill and have been expanded to include the Transparency property.
The ColumnInterior and Column3DInterior objects represent the 2D and 3D curve fill of columns and have been expanded to include the Transparency property.
The GridInterior object represents the background of a 2D diagram and has been expanded to include the MapType property.
The LineFormat object represents the line format and has been expanded to include the Transparency property.
The FillFormat object represents the line fill format and has been expanded to include the Transparency property.
The IsometricAxes property data type of the Diagram3D object has been changed from Boolean to Fp3DIsometricAxes. You can now use this to enable or disable isometry separately for individual planes.
The ColumnTableColumnData object represents the table column data and has been expanded to include the TimeDisplay property.
The ColumnTableColumnColumnIndex object represents the column index data of a table column and has been expanded to include the TimeDisplay property.
The ImportSettings object represents the settings for the data import and has been expanded to include the properties DataRange, RangeFrom, RangeTo and RangeDuration .
The new WindowActivatedevent shows when a window is activated and has been added to the Windows and Window objects.
New list types
The list types FpCursorSynchronizationMode, FpDataRange, FpTimeDisplay, FpDataQueryResult, FpDataQuerySource, FpDataQueryScope, FpMapType, Fp3DIsometricAxes, FpFormulaResultListItemNaming, 'FpAssignHeader and FpFileIndexingMode have been added.
Changes to existing list types
The list type FpShapeType now includes fpShapeTypeGeographicMap.
The list type FpObjectType now includes fpObjectTypeDataQuery.
The list type FpTaskWindows now includes fpTaskWindowDataExplorer.
The list type FpMoveCursor now includes the following: fpMoveCursorRightEdge, fpMoveCursorLeftEdge, fpMoveCursorUppperEdge, fpMoveCursorLowerEdge, fpMoveCursorFrontEdge, fpMoveCursorRearEdge, fpMoveCursorBothRightEdge, fpMoveCursorBothLeftEdge, fpMoveCursorBothUppperEdge, fpMoveCursorBothLowerEdge, fpMoveCursorBothFrontEdge and fpMoveCursorBothRearEdge.
The list type FpAxisScalingType now includes fpAxisScalingTypeMercatorLatitude.
The list type fpSearchItem now includes a large number of additional items.
The list type FpSearchCompareOp now includes the following: fpSearchCompareOpTextIsNot, fpSearchCompareOpVoidValuesAvailable, fpSearchCompareOpVoidValuesNotAvailable, fpSearchCompareOpValueIsTrue, fpSearchCompareOpValueIsFalse, fpSearchCompareOpDataTypeIs, fpSearchCompareOpDataTypeIsNot, fpSearchCompareOpDataStructureIs and fpSearchCompareOpDataStructureIsNot. The items fpSearchCompareOpObjectTypeIsKindOf and fpSearchCompareOpObjectTypeIsNotKindOf have been renamed to fpSearchCompareOpObjectTypeIs and fpSearchCompareOpObjectTypeIsNot. The old names are still supported, but if you use them in your code you should change the code to reflect the new names.
In the FpSignalSamplingResult list type the fpSignalSamplingResultSampleSamplingRate has been renamed to fpSignalSamplingResultSampleSamplingInterval. The old name is still supported, but if you use it in your code you should change the code to reflect the new name.
The list type FpImportFilterOptions now includes the following: fpImportOptionRange, fpImportOptionNoRange, fpImportOptionInteractive, fpImportOptionReadOnly and fpImportOptionNoIndexing. The elements fpImportOptionAutomatic and fpImportOptionManual have been renamed to fpImportOptionComplete and fpImportOptionNotComplete. The old names are still supported, but if you use them in your code you should change the code to reflect the new names.
The list type FpExportFormat now includes fpExportFormatFlexProText4.
The list type FpColor now includes fpColorAutomatic.
The list type FpParameterType now includes fpParameterTypeObjectRef, and the elements FpParameterType, fpParameterTypeFile and fpParameterTypeObject have been renamed to fpParameterTypeFolderPath, fpParameterTypeFilePath and fpParameterTypeObjectPath. The changes are backward compatible. The old names which are used where items have been renamed are still supported. However, we recommend changing the code to use the new names.
See Also
What's New in FlexPro 9's Object Model