🔍 Code Extractor

A SharePoint field class that represents currency values, extending FieldNumber with currency-specific formatting capabilities.

Purpose

FieldCurrency is a specialized field type for SharePoint that handles currency values with locale-specific formatting. It inherits from FieldNumber and adds currency locale identifier (LCID) support to properly format monetary values according to regional standards. This class is used when defining or working with currency columns in SharePoint lists and libraries.

Source Code

class FieldCurrency(FieldNumber):
    """Specifies a field (2) that contains currency values. To set properties, call the Update method
    (section 3.2.5.43.2.1.5)."""

    @property
    def currency_locale_id(self):
        """
        Gets the language code identifier (LCID) used to format the value of the field.

        :rtype: int or None
        """
        return self.properties.get("CurrencyLocaleId", None)

    @currency_locale_id.setter
    def currency_locale_id(self, value):
        """
        Sets the language code identifier (LCID) used to format the value of the field.

        :type value: int
        """
        self.set_property("CurrencyLocaleId", value)

Parameters

Parameter Details

__init__: Inherits constructor from FieldNumber parent class. The exact parameters depend on the parent class implementation, but typically include field metadata such as name, internal name, and other SharePoint field properties.

Return Value

Instantiation returns a FieldCurrency object that represents a SharePoint currency field. The currency_locale_id property getter returns an integer LCID value or None if not set. The property setter does not return a value (returns None implicitly).

Class Interface

Methods

Attributes

Dependencies

• office365.sharepoint.fields.number

Required Imports

from office365.sharepoint.fields.currency import FieldCurrency
from office365.sharepoint.fields.number import FieldNumber

Usage Example

# Assuming you have a SharePoint context and list object
from office365.sharepoint.fields.currency import FieldCurrency

# Get an existing currency field from a SharePoint list
currency_field = list_obj.fields.get_by_internal_name_or_title('Price')

# Set the currency locale to US English (LCID 1033)
currency_field.currency_locale_id = 1033

# Update the field on the server
currency_field.update()
ctx.execute_query()

# Get the current locale ID
locale_id = currency_field.currency_locale_id
print(f'Currency locale ID: {locale_id}')

Best Practices

• Always call the Update method after modifying the currency_locale_id property to persist changes to SharePoint
• Use valid LCID values that correspond to actual locale identifiers (e.g., 1033 for en-US, 1036 for fr-FR)
• Ensure proper SharePoint context is established before accessing or modifying field properties
• The currency_locale_id property may return None if not explicitly set, so handle this case in your code
• Inherit from this class if you need to extend currency field functionality with additional properties
• Use the set_property method (inherited from parent) for setting other field properties beyond currency_locale_id

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class CurrencyList 76.3% similar

  A SharePoint entity class that provides access to the list of supported currencies in SharePoint currency columns.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/currency.py

• class FieldNumber 70.6% similar

  A specialized Field class for SharePoint number fields that provides properties to control number formatting, decimal places, separators, and percentage display.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/fields/number.py

• class CurrencyInformationCollection 68.5% similar

  A collection class that holds a list of CurrencyInformation objects representing supported currencies in SharePoint.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/currency_information_collection.py

• class CurrencyInformation 67.7% similar

  A data class that encapsulates currency information including display formatting, language/culture settings, and locale identifiers for UI presentation.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/lists/currency_information.py

• class FieldCalculated 62.1% similar

  Represents a calculated field in a SharePoint list that derives its value from a formula based on other fields.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/fields/calculated.py