OpenXLSX 1.9.1
Loading...
Searching...
No Matches
OpenXLSX::XLDataValidations Class Reference

#include <XLDataValidation.hpp>

Data Structures

class  Iterator
 

Public Member Functions

 XLDataValidations ()
 
 XLDataValidations (const XMLNode &node)
 
bool empty () const
 
size_t count () const
 
XLDataValidation append ()
 
XLDataValidation addValidation (const XLDataValidationConfig &config, std::string_view sqref)
 
XLDataValidation add (std::string_view sqref)
 Quick fluent factory for adding a validation rule to a cell range.
 
XLDataValidation at (size_t index)
 
XLDataValidation at (std::string_view sqref)
 
void clear ()
 
void remove (size_t index)
 
void remove (std::string_view sqref)
 
bool disablePrompts () const
 
void setDisablePrompts (bool disable)
 
uint32_t xWindow () const
 
void setXWindow (uint32_t x)
 
uint32_t yWindow () const
 
void setYWindow (uint32_t y)
 
Iterator begin () const
 
Iterator end () const
 

Constructor & Destructor Documentation

◆ XLDataValidations() [1/2]

OpenXLSX::XLDataValidations::XLDataValidations ( )
inline

◆ XLDataValidations() [2/2]

OpenXLSX::XLDataValidations::XLDataValidations ( const XMLNode node)
inlineexplicit

Member Function Documentation

◆ add()

XLDataValidation OpenXLSX::XLDataValidations::add ( std::string_view  sqref)

Quick fluent factory for adding a validation rule to a cell range.

Parameters
sqrefThe cell range (e.g. "A1:A10")
Returns
The newly created XLDataValidation object.

◆ addValidation()

XLDataValidation OpenXLSX::XLDataValidations::addValidation ( const XLDataValidationConfig config,
std::string_view  sqref 
)

◆ append()

XLDataValidation OpenXLSX::XLDataValidations::append ( )

◆ at() [1/2]

XLDataValidation OpenXLSX::XLDataValidations::at ( size_t  index)

◆ at() [2/2]

XLDataValidation OpenXLSX::XLDataValidations::at ( std::string_view  sqref)

◆ begin()

Iterator OpenXLSX::XLDataValidations::begin ( ) const
inline

◆ clear()

void OpenXLSX::XLDataValidations::clear ( )

◆ count()

size_t OpenXLSX::XLDataValidations::count ( ) const

◆ disablePrompts()

bool OpenXLSX::XLDataValidations::disablePrompts ( ) const

◆ empty()

bool OpenXLSX::XLDataValidations::empty ( ) const
inline

◆ end()

Iterator OpenXLSX::XLDataValidations::end ( ) const
inline

◆ remove() [1/2]

void OpenXLSX::XLDataValidations::remove ( size_t  index)

◆ remove() [2/2]

void OpenXLSX::XLDataValidations::remove ( std::string_view  sqref)

◆ setDisablePrompts()

void OpenXLSX::XLDataValidations::setDisablePrompts ( bool  disable)

◆ setXWindow()

void OpenXLSX::XLDataValidations::setXWindow ( uint32_t  x)

◆ setYWindow()

void OpenXLSX::XLDataValidations::setYWindow ( uint32_t  y)

◆ xWindow()

uint32_t OpenXLSX::XLDataValidations::xWindow ( ) const

◆ yWindow()

uint32_t OpenXLSX::XLDataValidations::yWindow ( ) const

The documentation for this class was generated from the following files: