Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface IEditableCollectionView

    Show / Hide Table of Contents

    Interface IEditableCollectionView

    Defines methods and properties that a System.Windows.Data.CollectionView implements to provide editing capabilities to a collection.

    Namespace: Syncfusion.Data
    Assembly: Syncfusion.Data.Portable.dll
    Syntax
    public interface IEditableCollectionView

    Properties

    CanAddNew

    Gets a value that indicates whether a new item can be added to the collection.

    Declaration
    bool CanAddNew { get; }
    Property Value
    Type Description
    System.Boolean

    True if a new item can be added to the collection, otherwisefalse.

    CanCancelEdit

    Gets a value that indicates whether the collection view can discard pending changes and restore the original values of an edited object.

    Declaration
    bool CanCancelEdit { get; }
    Property Value
    Type Description
    System.Boolean

    CanRemove

    Gets a value that indicates whether an item can be removed from the collection.

    Declaration
    bool CanRemove { get; }
    Property Value
    Type Description
    System.Boolean

    True if an item can be removed from the collection, otherwise false.

    CurrentAddItem

    Gets the item that is being added during the current add transaction.

    Declaration
    object CurrentAddItem { get; }
    Property Value
    Type Description
    System.Object

    The item that is being added if IsAddingNew is true, otherwise null.

    CurrentEditItem

    Gets the item in the collection that is being edited.

    Declaration
    object CurrentEditItem { get; }
    Property Value
    Type Description
    System.Object

    The item in the collection that is being edited if IsEditingItem is true, otherwise null.

    IsAddingNew

    Gets a value that indicates whether an add transaction is in progress.

    Declaration
    bool IsAddingNew { get; }
    Property Value
    Type Description
    System.Boolean

    True if an add transaction is in progress, otherwise false.

    IsEditingItem

    Gets a value that indicates whether an edit transaction is in progress.

    Declaration
    bool IsEditingItem { get; }
    Property Value
    Type Description
    System.Boolean

    True if an edit transaction is in progress, otherwise false.

    NewItemPlaceholderPosition

    Gets or sets the position of the new item placeholder in the collection view.

    Declaration
    NewItemPlaceholderPosition NewItemPlaceholderPosition { get; set; }
    Property Value
    Type Description
    NewItemPlaceholderPosition

    One of the enumeration values of NewItemPlaceholderPosition that specifies the position of the new item placeholder in the collection view.

    Methods

    AddNew()

    Adds a new item to the collection.

    Declaration
    object AddNew()
    Returns
    Type Description
    System.Object

    The new item that is added to the collection.

    CancelEdit()

    Ends the edit transaction and, if possible, restores the original value to the item.

    Declaration
    void CancelEdit()

    CancelNew()

    Ends the add transaction and discards the pending new item.

    Declaration
    void CancelNew()

    CommitEdit()

    Ends the edit transaction and saves the pending changes.

    Declaration
    void CommitEdit()

    CommitNew()

    Ends the add transaction and saves the pending new item.

    Declaration
    void CommitNew()

    EditItem(Object)

    Begins an edit transaction of the specified item.

    Declaration
    void EditItem(object item)
    Parameters
    Type Name Description
    System.Object item

    The item to edit.

    Remove(Object)

    Removes the item at the specified position from the collection.

    Declaration
    void Remove(object item)
    Parameters
    Type Name Description
    System.Object item

    The position of the item to remove.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    Index is less than 0 or greater than the number of items in the collection view.

    RemoveAt(Int32)

    Removes the item at the specified position from the collection.

    Declaration
    void RemoveAt(int index)
    Parameters
    Type Name Description
    System.Int32 index

    The position of the item to remove.

    Exceptions
    Type Condition
    System.ArgumentOutOfRangeException

    Index is less than 0 or greater than the number of items in the collection view.

    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved