Interface Edit in Excel Field Filter

App
System Application
Namespace
System.Integration.Excel
Versions
22-27, not in 28
Obsolete
Pending 25.0, seen from 25. Replaced by "Edit in Excel Field Filter v2" with support for getting the collection type of the filter.

Procedures, 4Obsolete, 1

Versions171819202122232425262728

Source24252627

Source in 27

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

#if not CLEAN25
// ------------------------------------------------------------------------------------------------
// 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;

    ObsoleteState = Pending;
    ObsoleteTag = '25.0';
    ObsoleteReason = 'Replaced by "Edit in Excel Field Filter v2" with support for getting the collection type of the filter.';

    /// <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>
#pragma warning disable AL0432
    procedure AddFilterValue(EditInExcelFilterType: Enum "Edit in Excel Filter Type"; FilterValue: Text): Interface "Edit in Excel Field Filter"
#pragma warning restore AL0432

    /// <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
}
#endif