Skip to main content
All docs
V25.1
  • TdxChartPaletteRepository.FindPalette(string,Boolean) Method

    Returns the stored user or standard palette with the specified name.

    Declaration

    function FindPalette(const AName: string; AAllowStandardPalette: Boolean = True): TdxChartPalette;

    Parameters

    Name Type Description
    AName string

    The target user or standard palette name.

    The function iterates through stored palettes and returns the palette whose name matches the parameter value.

    If the repository contains no palette with the required name, the function returns nil (in Delphi) or nullptr (in C++Builder).

    AAllowStandardPalette Boolean

    Optional. Specifies if the function searches a palette with the specified name among the list of predefined palettes:

    True
    Default. The function iterates through all stored color palettes and returns the palette whose name matches the AName parameter value.
    False
    The function iterates only through the list of user palettes and returns the palette whose name matches the AName parameter value.

    Returns

    Type Description
    TdxChartPalette

    The stored user or standard palette whose name matches the AName parameter value.

    The function returns nil (in Delphi) or nullptr (in C++Builder) if the repository contains no palette with the specified name.

    Tip

    Cast the returned value to the TdxChartUserPalette class if it is a user palette to access all public API members. Call the ClassType function to identify the actual palette class.

    See Also