Interface Edit in Excel Field Filter, source in 24

Source24252627metadata in 24

src/System Application/App/Edit in Excel/src/Filters/EditInExcelFieldFilter.Interface.al42 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// ------------------------------------------------------------------------------------------------

namespace System.Integration.Excel;

/// <summary>
/// This codeunit provides an interface to create a filter for a specific field for Edit in Excel.
/// </summary>
interface "Edit in Excel Field Filter"
{
    Access = Public;

    /// <summary>
    /// Add a filter value
    /// </summary>
    /// <param name="EditInExcelFilterType">The filter type, such as Equal, Greater than.</param>
    /// <param name="FilterValue">The value which the field should be Equal to, Greater than etc.</param>
    procedure AddFilterValue(EditInExcelFilterType: Enum "Edit in Excel Filter Type"; FilterValue: Text): Interface "Edit in Excel Field Filter"

    /// <summary>
    /// Get a specific filter
    /// </summary>
    /// <param name="Index">The index of the filter.</param>
    /// <param name="EditInExcelFilterType">The filter type, such as Equal, Greater than.</param>
    /// <param name="FilterValue">The value which the field should be Equal to, Greater than etc.</param>
    procedure Get(Index: Integer; var EditinExcelFilterType: Enum "Edit in Excel Filter Type"; var FilterValue: Text)

    /// <summary>
    /// Remove a specific filter
    /// </summary>
    /// <param name="Index">The index of the filter.</param>
    procedure Remove(Index: Integer)

    /// <summary>
    /// Counts the number of filters
    /// </summary>
    /// <returns>The number of filters</returns>
    procedure Count(): Integer
}