OpenXLSX 1.9.1
Loading...
Searching...
No Matches
Public Member Functions
OpenXLSX::XLAutoFilter Class Reference

#include <XLAutoFilter.hpp>

Public Member Functions

 XLAutoFilter (XMLNode node)
 Constructor.
 
 operator bool () const
 Check if the AutoFilter object is valid (has a corresponding XML node).
 
std::string ref () const
 Get the reference range of the AutoFilter.
 
XLAutoFilter & setRef (const std::string &ref)
 Set the reference range of the AutoFilter.
 
XLAutoFilter & setRef (const XLCellRange &range)
 Set the reference range of the AutoFilter using a strongly-typed XLCellRange.
 
XLFilterColumn filterColumn (uint16_t colId)
 Get or create a filter column by its ID.
 

Constructor & Destructor Documentation

◆ XLAutoFilter()

OpenXLSX::XLAutoFilter::XLAutoFilter ( XMLNode  node)
explicit

Constructor.

Parameters
nodeThe <autoFilter> XMLNode

Member Function Documentation

◆ filterColumn()

XLFilterColumn OpenXLSX::XLAutoFilter::filterColumn ( uint16_t  colId)

Get or create a filter column by its ID.

Parameters
colIdThe 0-based column ID relative to the AutoFilter range.
Returns
The XLFilterColumn object.

◆ operator bool()

OpenXLSX::XLAutoFilter::operator bool ( ) const

Check if the AutoFilter object is valid (has a corresponding XML node).

Returns
true if valid, false otherwise.

◆ ref()

std::string OpenXLSX::XLAutoFilter::ref ( ) const

Get the reference range of the AutoFilter.

Returns
A string containing the reference (e.g., "A1:C10").

◆ setRef() [1/2]

XLAutoFilter & OpenXLSX::XLAutoFilter::setRef ( const std::string &  ref)

Set the reference range of the AutoFilter.

Parameters
refThe reference range to set.

◆ setRef() [2/2]

XLAutoFilter & OpenXLSX::XLAutoFilter::setRef ( const XLCellRange &  range)

Set the reference range of the AutoFilter using a strongly-typed XLCellRange.

Parameters
rangeThe XLCellRange object.
The documentation for this class was generated from the following files: