Aspose.Cells FOSS for PHP

API reference for Aspose.Cells FOSS for Php. 223 public types organized by module.

Core API

ClassDescription
AlignmentValueClass with 2 methods and 8 properties.
AutoFilterClass with 4 methods and 2 properties.
AutoFilterColorFilterAutoFilterColorFilter.Clear() clears any color‑based filter criteria applied to an auto‑filter column.
AutoFilterColorFilterModelClass with 1 method and 3 properties.
AutoFilterCustomFilterClass with 3 methods.
AutoFilterCustomFilterCollectionClass with 13 methods.
AutoFilterCustomFilterModelClass with 2 properties.
AutoFilterDynamicFilterClass with 4 methods.
AutoFilterDynamicFilterModelAutoFilterDynamicFilterModel lets developers enable a dynamic filter, choose its type, and set single or range values via the Enabled, Type, Value, and MaxValue properties.
AutoFilterModelClass with 3 methods and 3 properties.
AutoFilterSortConditionClass with 3 methods.
AutoFilterSortConditionCollectionClass with 13 methods.
AutoFilterSortConditionModelClass with 7 properties.
AutoFilterSortStateAutoFilterSortState.Clear() removes all sort conditions from a worksheet’s auto‑filter, resetting its sort state.
AutoFilterSortStateModelClass with 3 methods and 5 properties.
AutoFilterSupportAutoFilterSupport enables developers to normalize optional and required filter range strings, parse filter operators, and compare filter columns when configuring worksheet auto‑filters.
AutoFilterTop10Class with 4 methods.
AutoFilterTop10ModelClass with 1 method and 5 properties.
AutoShapeTypeClass with 39 methods.
BorderThe Border.Clone() method returns a deep copy of a border, allowing independent modification of border styles on different cells.
BorderSideValueClass with 2 methods and 2 properties.
BorderStyleBorderStyle provides a set of predefined border styles—Thin, Medium, Thick, Dotted, Dashed, Double, Hair, MediumDashed, DashDot, MediumDashDot, DashDotDot, MediumDashDotDot, and SlantedDashDot—for cell formatting.
BorderStyleTypeBorderStyleType provides a set of methods such as Thin, Medium, Thick, Dotted, Dashed, Double, and others to specify common cell border styles.
BordersClass with 2 methods and 7 properties.
BordersValueClass with 2 methods and 7 properties.
CalculationPropertiesClass with 3 methods.
CalculationPropertiesModelClass with 2 methods and 12 properties.
CellCell styling—including fonts, fills, borders, alignment, and protection—can be configured via the properties of the CellFormatValue class (NumFmtId, FontId, FillId, BorderId, Alignment, Protection).
CellAddressCellAddress.Parse(cellReference) converts a string like “B3” into a CellAddress object exposing RowIndex and ColumnIndex, and can be compared with Equals(other).
CellAreaClass with 6 methods and 4 properties.
CellFormatValueClass with 1 method and 6 properties.
CellRecordClass with 1 method and 5 properties.
CellValueKindClass with 7 methods.
CellValueTypeCellValueType offers methods like IsNumeric() and IsDateTime() so code can safely branch based on a cell’s runtime data type.
CellsClass with 8 methods and 2 properties.
CellsExceptionClass with 1 method.
ChartClass with 3 methods.
ChartCollectionClass with 9 methods.
ChartCompanionFileClass with 4 properties.
ChartModelClass with 1 method and 17 properties.
ChartTargetChartTarget objects expose a Uri property and an IsChartEx flag, allowing developers to reference external chart resources and identify chart extensions.
ChartTypeClass with 26 methods.
ChartXmlTemplatesChartXmlTemplates.Build(type, dataRange, chartTitle) creates an XML template for a chart of the specified type, using the given data range and title.
ColorClass with 8 methods and 4 properties.
ColorValueClass with 4 methods and 7 properties.
ColumnClass with 3 methods.
ColumnCollectionClass with 5 methods.
ColumnRangeModelClass with 5 properties.
CommentClass with 3 methods.
CommentCollectionClass with 10 methods.
CommentModelClass with 1 method and 8 properties.
ConditionalFormattingCollectionClass with 12 methods.
ConditionalFormattingModelClass with 1 method and 2 properties.
CoreDocumentPropertiesClass with 3 methods.
CoreDocumentPropertiesModelClass with 2 methods and 11 properties.
CultureInfoMinimal CultureInfo shim.
DateSerialConverterClass with 3 methods.
DateSystemDateSystem provides static helpers Windows1900() and Mac1904() to select the workbook’s date system.
DateTimeFormatInfoMinimal DateTimeFormatInfo shim carrying date and time names and patterns.
DefinedNameClass with 3 methods.
DefinedNameCollectionClass with 12 methods.
DefinedNameModelClass with 5 properties.
DefinedNameUtilityClass with 8 methods.
DiagnosticBagClass with 4 methods.
DiagnosticEntryClass with 1 method and 5 properties.
DiagnosticSeverityClass with 4 methods.
DisplayFormatSectionInfoClass with 4 properties.
DisplayTextDateFormatSupportClass with 8 methods.
DisplayTextFormatterClass with 2 methods.
DisplayTextFormatterSupportClass with 16 methods.
DisplayTextLocaleSupportClass with 1 method.
DisplayTextNumberSupportEmulates .NET custom numeric format strings for native PHP int/float values.
DocumentPropertiesClass with 3 methods.
DocumentPropertiesModelClass with 3 methods and 2 properties.
ExtendedDocumentPropertiesClass with 3 methods.
ExtendedDocumentPropertiesModelClass with 2 methods and 9 properties.
ExternalLinkModelClass with 2 properties.
FillPatternClass with 18 methods.
FillPatternKindClass with 18 methods.
FillValueClass with 1 method and 3 properties.
FilterColumnClass with 4 methods and 5 properties.
FilterColumnCollectionClass with 13 methods.
FilterColumnModelClass with 3 methods and 8 properties.
FilterOperatorTypeFilterOperatorType provides static methods such as Equal() and GreaterThan() to specify comparison operators when building filter conditions.
FilterValueCollectionClass with 13 methods.
FontFont.Clone() creates a deep copy of a Font object, preserving its name, size, style, and color settings.
FontUnderlineTypeClass with 20 methods.
FontValueClass with 2 methods and 7 properties.
FormatConditionClass with 4 methods.
FormatConditionCollectionClass with 17 methods.
FormatConditionModelClass with 1 method and 26 properties.
FormatConditionTypeClass with 16 methods.
FormulaExceptionClass with 2 methods.
HeaderFooterModelHeaderFooterModel lets developers set worksheet headers and footers via its LeftHeader, CenterHeader, RightHeader, LeftFooter, CenterFooter, and RightFooter properties.
HorizontalAlignmentClass with 8 methods.
HorizontalAlignmentTypeClass with 8 methods.
HyperlinkModelClass with 8 properties.
ImageTypeClass with 5 methods.
InvalidFileFormatExceptionClass with 1 method.
ListColumnClass with 5 methods.
ListColumnCollectionClass with 8 methods.
ListColumnModelClass with 1 method and 5 properties.
ListObjectClass with 7 methods and 1 property.
ListObjectCollectionListObjectCollection implements PHP’s array‑access and countable interfaces, allowing tables (list objects) to be added, removed, enumerated, and accessed by index directly from a worksheet.
ListObjectModelClass with 1 method and 16 properties.
ListObjectSupportClass with 10 methods.
LoadDiagnosticsLoadDiagnostics captures issues encountered while loading workbooks, helping developers identify data‑loss risks during import.
LoadFormatClass with 2 methods.
LoadIssueClass with 1 method and 9 properties.
LoadOptionsLoadOptions lets developers enable package‑level and XML‑level repair by setting TryRepairPackage and TryRepairXml to true before loading a workbook.
MergeRegionClass with 1 method and 4 properties.
NumberFormatClass with 4 methods.
NumberFormatInfoMinimal NumberFormatInfo shim carrying the invariant culture’s numeric separators, group sizes and sign symbols.
NumberFormatValueClass with 1 method and 2 properties.
OperatorTypeClass with 9 methods.
PageMarginsModelClass with 6 properties.
PageOrientationClass with 3 methods.
PageOrientationTypePageOrientationType.Portrait() returns the enum value representing portrait orientation for worksheet page setup.
PageSetupPageSetup.AddHorizontalPageBreak(rowIndex) inserts a page break before the given row, enabling custom print pagination.
PageSetupModelClass with 1 method and 14 properties.
PaperSizeTypeClass with 11 methods.
PicturePicture.ImageTypeFromExtension(extension) returns the internal image type enum for a given file extension, enabling correct handling of picture data.
PictureCollectionPictureCollection.Add(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn, imageDataOrStreamOrFileName) inserts an image into a worksheet at the specified cell range.
PictureModelClass with 1 method and 14 properties.
PrintOptionsModelClass with 4 properties.
ProtectionValueClass with 2 methods and 2 properties.
RowClass with 3 methods.
RowCollectionClass with 5 methods.
RowModelClass with 3 properties.
SaveFormatClass with 1 method.
SaveOptionsSaveOptions controls workbook saving behavior; properties include SaveFormat, UseSharedStrings, ValidateBeforeSave, CompactStyles, and PreserveRecoveryMetadata.
ShapeClass with 5 methods.
ShapeCollectionShapeCollection enables adding geometric shapes to a worksheet with Add(upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn, shapeType) and removing them via RemoveAt(index).
ShapeImageModelClass with 3 properties.
ShapeModelShapeModel provides properties such as UpperLeftRow, UpperLeftColumn, and ExtentCx to position and size shapes precisely on a worksheet.
SharedStringRepositoryClass with 6 methods.
SheetVisibilityClass with 3 methods.
StyleThe Style class provides methods to copy, clone, compare, and convert styles, and exposes Font, Borders, Pattern, colors, number format, and alignment properties for full cell styling.
StyleExceptionClass with 2 methods.
StyleFlagClass with 29 properties.
StyleRepositoryClass with 1 method.
StyleValueStyleValue provides full styling control, exposing Font, Pattern, ForegroundColor, BackgroundColor, Borders, Alignment, Protection, NumberFormat, and QuotePrefix properties.
StyleValueSanitizerClass with 3 methods.
StylesheetLoadContextClass with 1 method and 4 properties.
StylesheetSaveContextClass with 3 methods and 3 properties.
TableStyleTypeClass with 62 methods.
TargetModeTypeTargetModeType.External() creates a target mode indicating that a hyperlink points to an external resource.
TotalsCalculationClass with 10 methods.
UnsupportedFeatureExceptionClass with 2 methods.
ValidationClass with 5 methods.
ValidationAlertTypeClass with 3 methods.
ValidationCollectionValidationCollection.Add(area) creates a data validation rule for the specified cell range, and the collection provides methods to retrieve, remove, and compare validation areas.
ValidationModelClass with 1 method and 14 properties.
ValidationTypeClass with 8 methods.
VerticalAlignmentClass with 5 methods.
VerticalAlignmentTypeClass with 5 methods.
VisibilityTypeClass with 3 methods.
WarningInfoClass with 8 properties.
WorkbookWorkbook.Save(fileName, options) writes the current workbook to the specified .xlsx file.
WorkbookLoadExceptionClass with 1 method.
WorkbookModelWorkbookModel.Properties provides access to workbook‑level settings such as CodeName, ShowObjects, and BackupFile via the WorkbookPropertiesModel class.
WorkbookPropertiesClass with 3 methods.
WorkbookPropertiesModelClass with 3 methods and 13 properties.
WorkbookPropertySupportWorkbookPropertySupport normalizes workbook settings such as ShowObjects, UpdateLinks, Visibility, CalculationMode, and ReferenceMode to ensure valid values before saving.
WorkbookProtectionClass with 3 methods.
WorkbookProtectionModelClass with 2 methods and 5 properties.
WorkbookSaveExceptionClass with 1 method.
WorkbookSettingsClass with 3 methods.
WorkbookSettingsModelClass with 1 method and 2 properties.
WorkbookViewClass with 3 methods.
WorkbookViewModelClass with 2 methods and 12 properties.
WorksheetClass with 5 methods.
WorksheetCollectionWorksheetCollection.Add(sheetName) creates a new worksheet with the given name and adds it to the workbook.
WorksheetDefinedNamesStateClass with 3 properties.
WorksheetModelClass with 1 method and 20 properties.
WorksheetProtectionClass with 4 methods.
WorksheetProtectionModelWorksheetProtectionModel lets developers configure protection flags such as IsProtected, Objects, Scenarios, FormatCells, FormatColumns, FormatRows, InsertColumns, InsertRows, InsertHyperlinks, and DeleteColumns.
WorksheetViewModelClass with 5 properties.
XlsxDocumentPropertiesClass with 8 methods.
XlsxWorkbookArchiveHelpersClass with 20 methods.
XlsxWorkbookAutoFilterClass with 2 methods.
XlsxWorkbookCommentsClass with 10 methods.
XlsxWorkbookCommentsLoaderClass with 1 method.
XlsxWorkbookConditionalFormattingClass with 2 methods.
XlsxWorkbookDefinedNamesClass with 2 methods.
XlsxWorkbookPageSetupClass with 11 methods.
XlsxWorkbookPicturesClass with 20 methods.
XlsxWorkbookPicturesLoaderClass with 4 methods.
XlsxWorkbookPropertiesClass with 5 methods.
XlsxWorkbookSerializerClass with 2 methods.
XlsxWorkbookSerializerCommonProvides shared serialization helpers for the XLSX workbook writer.
XlsxWorkbookStylesClass with 5 methods.
XlsxWorkbookStylesValueHelpersClass with 8 methods.
XlsxWorkbookStylesXmlXlsxWorkbookStylesXml contains methods to read and build style components, including ReadFontValues, BuildFontElements, ReadFillValues, BuildFillElements, ReadBordersValues, and BuildBorderElements.
XlsxWorkbookTablesClass with 7 methods.
XlsxWorkbookValidationsClass with 2 methods.
XlsxWorkbookWorksheetLoaderClass with 2 methods.
XlsxWorkbookWorksheetProtectionClass with 2 methods.
XlsxWorkbookWorksheetViewsClass with 3 methods.
XlsxWorkbookWorksheetWriterClass with 12 methods.

Interfaces

InterfaceDescription
IListObjectOwnerInterface with 3 methods.
IWarningCallbackInterface with 1 method.

Navigation

ClassDescription
HyperlinkClass with 6 methods.
HyperlinkCollectionClass with 11 methods.
XlsxWorkbookHyperlinksXlsxWorkbookHyperlinks provides methods such as BuildHyperlinksElement, LoadHyperlinks, and GetOrderedHyperlinks to create, read, and order hyperlink relationships in a worksheet.

Packaging

ClassDescription
MissingPartExceptionClass with 1 method.
PackageLoadContextClass with 1 method and 2 properties.
PackageModelClass with 3 properties.
PackagePartDescriptorClass with 3 properties.
PackageStructureExceptionClass with 1 method.
PackagingConventionsPackagingConventions.WorkbookPart() returns the standard part name for the workbook XML within an Open XML package.
RelationshipDescriptorClass with 4 properties.
RelationshipResolutionExceptionClass with 1 method.

Interfaces

InterfaceDescription
IPackageReaderInterface with 1 method.
IPackageWriterIPackageWriter.Write(stream, packageModel) serializes a workbook’s package model to the provided stream, enabling custom save destinations.

Validation

ClassDescription
ValidationMessageClass with 3 properties.
ValidationMessageSeverityClass with 3 methods.
WorkbookValidatorWorkbookValidator.ValidateForSave(workbookModel, packageModel) runs validation checks on a workbook before it is saved, ensuring the generated OpenXML package meets specification requirements.

Xml

ClassDescription
SharedStringTableXmlMapperClass with 2 methods.
StylesheetXmlMapperClass with 2 methods.
WorkbookXmlMapperClass with 2 methods.
WorksheetXmlMapperClass with 2 methods.
XmlParsingExceptionClass with 1 method.

See Also