Skip To Content ArcGIS for Developers Sign In Dashboard

PopupFieldFormat Class

class Esri::ArcGISRuntime::PopupFieldFormat

The formatting of a field when used in a Popup. More...

Header: #include <PopupFieldFormat>
Since: Esri::ArcGISRuntime 100.0
Inherits: Esri::ArcGISRuntime::Object

This class was introduced in Esri::ArcGISRuntime 100.0.

Public Functions

PopupFieldFormat(QObject *parent = nullptr)
virtual ~PopupFieldFormat() override
int decimalPlaces() const
bool isUseThousandsSeparator() const
Esri::ArcGISRuntime::PopupDateFormat popupDateFormat() const
void setDecimalPlaces(int decimalPlaces)
void setPopupDateFormat(Esri::ArcGISRuntime::PopupDateFormat popupDateFormat)
void setUseThousandsSeparator(bool useThousandsSeparator)

Detailed Description

Applies only to fields of type date or number (float, double, integer). Use the PopupManager::fieldType method to determine the field type.

Member Function Documentation

PopupFieldFormat::PopupFieldFormat(QObject *parent = nullptr)

Default constructor that takes an optional parent.

[override virtual] PopupFieldFormat::~PopupFieldFormat()

Destructor.

int PopupFieldFormat::decimalPlaces() const

Returns the number of decimal places that should appear for displaying a numerical field in a Popup.

See also setDecimalPlaces().

bool PopupFieldFormat::isUseThousandsSeparator() const

Returns whether a numerical field will use the thousands (or digit) separator when the field is displayed in a Popup.

Esri::ArcGISRuntime::PopupDateFormat PopupFieldFormat::popupDateFormat() const

Returns the format used to display a date field in a Popup.

See also setPopupDateFormat().

void PopupFieldFormat::setDecimalPlaces(int decimalPlaces)

Sets the number of supported decimalPlaces that should appear for displaying a numerical field in a Popup.

See also decimalPlaces().

void PopupFieldFormat::setPopupDateFormat(Esri::ArcGISRuntime::PopupDateFormat popupDateFormat)

Sets the popupDateFormat used to display a date field in a Popup.

See also popupDateFormat().

void PopupFieldFormat::setUseThousandsSeparator(bool useThousandsSeparator)

Sets whether a numerical field may useThousandsSeparator when the field is displayed in a Popup.

See also isUseThousandsSeparator().


Feedback on this topic?