🔍 Code Extractor

ThemeInfo is a class that represents and manages theme information for a SharePoint site, providing access to theme properties and font configurations.

Purpose

This class serves as an entity wrapper for SharePoint site themes, allowing retrieval of theme-specific information such as fonts, background images, and accessibility descriptions. It inherits from Entity and provides methods to query theme fonts by name and language, as well as properties to access theme metadata. The class is designed to work within the Office365 SharePoint API context, enabling programmatic access to site theming information.

Source Code

class ThemeInfo(Entity):
    """Specifies a theme for a site"""

    def get_theme_font_by_name(self, name, lcid):
        """
        Returns the name of the theme font for the specified font slot name and language code identifier (LCID).
        MUST return null if the font slot does not exist.
        :param str name: Name of the font slot.
        :param int lcid: The language code identifier (LCID) for the required language.
        """
        return_type = ClientResult(self.context, str())
        payload = {"name": name, "lcid": lcid}
        qry = ServiceOperationQuery(
            self, "GetThemeFontByName", None, payload, None, return_type
        )
        self.context.add_query(qry)
        return return_type

    @property
    def accessible_description(self):
        """Specifies the accessible description for this theme.
        :rtype: str or None
        """
        return self.properties.get("AccessibleDescription", None)

    @property
    def theme_background_image_uri(self):
        """Specifies the URI of the background image for this theme.
        :rtype: str or None
        """
        return self.properties.get("ThemeBackgroundImageUri", None)

Parameters

Parameter Details

bases: Inherits from Entity class, which provides base functionality for SharePoint entities including context management and property handling. The Entity base class manages the connection to SharePoint and handles property storage and retrieval.

Return Value

Instantiation returns a ThemeInfo object that represents a SharePoint site theme. The get_theme_font_by_name method returns a ClientResult object containing a string with the theme font name, or null if the font slot doesn't exist. Properties return strings or None if the property is not set.

Class Interface

Methods

Attributes

Dependencies

• office365-runtime
• office365-sharepoint

Required Imports

from office365.runtime.client_result import ClientResult
from office365.runtime.queries.service_operation import ServiceOperationQuery
from office365.sharepoint.entity import Entity

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.theme_info import ThemeInfo

# Authenticate and get context
ctx = ClientContext(site_url).with_credentials(credentials)

# Get theme info (typically retrieved from site)
theme = ctx.web.theme_info
ctx.load(theme)
ctx.execute_query()

# Get theme font for a specific language
font_result = theme.get_theme_font_by_name('body', 1033)
ctx.execute_query()
font_name = font_result.value

# Access theme properties
description = theme.accessible_description
background_uri = theme.theme_background_image_uri

print(f'Font: {font_name}')
print(f'Description: {description}')
print(f'Background: {background_uri}')

Best Practices

• Always execute queries using context.execute_query() after calling get_theme_font_by_name to retrieve actual values from SharePoint
• Check if property values are None before using them, as theme properties may not be set
• Use appropriate LCID (Language Code Identifier) values when querying fonts - 1033 for US English is common
• Load the ThemeInfo object using context.load() before accessing properties to ensure data is populated
• The get_theme_font_by_name method returns a ClientResult object, access the actual value via the .value property after query execution
• Font slot names should match SharePoint's predefined theme font slots (e.g., 'body', 'heading', 'monospace')
• Handle null returns from get_theme_font_by_name gracefully as the method returns null for non-existent font slots
• This class is typically not instantiated directly but retrieved from a Site or Web object's theme_info property

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class ThemeProperties 73.3% similar

  ThemeProperties is a SharePoint entity class that represents theme properties for SharePoint Online tenant management.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/theme_properties.py

• class ThemeManager 68.7% similar

  SharePoint site theming REST interface that provides CRUD operations for managing site themes at the tenant level.

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

• class WebInformation 64.1% similar

  WebInformation is a data entity class that represents and stores metadata about a SharePoint site.

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

• class GroupSiteInfo 64.0% similar

  A data class representing information about a SharePoint group site, including its URL, status, and related metadata.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/groups/site_info.py

• class MembersInfo 63.3% similar

  MembersInfo is a SharePoint entity class that represents directory members information in the SharePoint API.

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