Class ContactsList

    Definition

    Namespace:
    Tizen.Pims.Contacts
    Assembly:
    Tizen.Pims.Contacts.dll

    A list of records with the same type.

    public class ContactsList : IDisposable
    Inheritance
    object
    ContactsList
    Implements
    System.IDisposable

    Constructors

    View Source

    ContactsList()

    Creates a contacts record list.

    Declaration
    public ContactsList()
    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    System.OutOfMemoryException

    Thrown when failed due to out of memory.

    Properties

    View Source

    Count

    The count of the contact entity.

    Declaration
    public int Count { get; }
    Property Value
    Type Description
    int

    The count of the contact entity.

    Methods

    View Source

    AddRecord(ContactsRecord)

    Adds a record to the contacts list.

    Declaration
    public void AddRecord(ContactsRecord record)
    Parameters
    Type Name Description
    ContactsRecord record

    The record to add.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    System.ArgumentException

    Thrown when one of the arguments provided to a method is not valid.

    View Source

    Dispose()

    Releases all the resources used by the ContactsList. It should be called after it has finished using the object.

    Declaration
    public void Dispose()
    View Source

    Dispose(bool)

    Releases all the resources used by the ContactsList.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    Disposing by the user.

    View Source

    ~ContactsList()

    The destructor.

    Declaration
    protected ~ContactsList()
    View Source

    GetCurrentRecord()

    Retrieves a record from the contacts list.

    Declaration
    public ContactsRecord GetCurrentRecord()
    Returns
    Type Description
    ContactsRecord

    The contacts record.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    MoveFirst()

    Moves a contacts list to the first position.

    Declaration
    public void MoveFirst()
    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    MoveLast()

    Moves a contacts list to the last position.

    Declaration
    public void MoveLast()
    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    MoveNext()

    Moves a contacts list to the next position.

    Declaration
    public bool MoveNext()
    Returns
    Type Description
    bool

    When the cursor is already at the last position, it returns false.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    MovePrevious()

    Moves a contacts list to the previous position.

    Declaration
    public bool MovePrevious()
    Returns
    Type Description
    bool

    When the cursor is already at the first position, it returns false.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    View Source

    RemoveRecord(ContactsRecord)

    Removes a record from the contacts list.

    Declaration
    public void RemoveRecord(ContactsRecord record)
    Parameters
    Type Name Description
    ContactsRecord record

    The record to remove.

    Exceptions
    Type Condition
    System.NotSupportedException

    Thrown when the feature is not supported.

    System.ArgumentException

    Thrown when one of the arguments provided to a method is not valid.

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX