Class ExcelThreadedCommentPersonCollection

Namespace

OfficeOpenXml.ThreadedComments

Assembly

EPPlus.dll

Represents a collection of ExcelThreadedCommentPersons in a workbook.

public class ExcelThreadedCommentPersonCollection : IEnumerable<ExcelThreadedCommentPerson>, IEnumerable

Inheritance

object

ExcelThreadedCommentPersonCollection

Implements

IEnumerable<ExcelThreadedCommentPerson>

IEnumerable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ExcelThreadedCommentPersonCollection(ExcelWorkbook)

Constructor

public ExcelThreadedCommentPersonCollection(ExcelWorkbook workbook)

Parameters

workbook ExcelWorkbook

The workbook where the ExcelThreadedCommentPerson occurs

Properties

Count

Number of ExcelThreadedCommentPersons in the collection

public int Count { get; }

Property Value

int

this[int]

Returns the ExcelThreadedCommentPerson by its index

public ExcelThreadedCommentPerson this[int index] { get; }

Parameters

index int

The requested index

Property Value

ExcelThreadedCommentPerson

The ExcelThreadedCommentPerson at the requested index

this[string]

Returns a ExcelThreadedCommentPerson by its id

public ExcelThreadedCommentPerson this[string id] { get; }

Parameters

id string

The Id of the Person

Property Value

ExcelThreadedCommentPerson

A ExcelThreadedCommentPerson with the requested id or null

PersonsXml

The xml document defining the threaded comments persons collection.

public XmlDocument PersonsXml { get; }

Property Value

XmlDocument

Methods

Add(string)

Creates and adds a new ExcelThreadedCommentPerson to the workbooks list of persons. A unique Id for the person will be generated and set. The userId will be the same as the displayName and identityProvider will be set to NoProvider

public ExcelThreadedCommentPerson Add(string displayName)

Parameters

displayName string

The display name of the added ExcelThreadedCommentPerson

Returns

ExcelThreadedCommentPerson

Add(string, string, IdentityProvider)

Creates and adds a new ExcelThreadedCommentPerson to the workbooks list of persons. A unique Id for the person will be generated and set.

public ExcelThreadedCommentPerson Add(string displayName, string userId, IdentityProvider identityProvider)

Parameters

displayName string

The display name of the added ExcelThreadedCommentPerson

userId string

A string representing the userId of the identityProvider

identityProvider IdentityProvider

The IdentityProvider from which the ExcelThreadedCommentPerson originates

Returns

ExcelThreadedCommentPerson

The added ExcelThreadedCommentPerson

Add(string, string, IdentityProvider, string)

Creates and adds a new ExcelThreadedCommentPerson to the workbooks list of persons

public ExcelThreadedCommentPerson Add(string displayName, string userId, IdentityProvider identityProvider, string id)

Parameters

displayName string

The display name of the added ExcelThreadedCommentPerson

userId string

A string representing the userId of the identityProvider

identityProvider IdentityProvider

The IdentityProvider from which the ExcelThreadedCommentPerson originates

id string

Id of the ExcelThreadedCommentPerson

Returns

ExcelThreadedCommentPerson

The added ExcelThreadedCommentPerson

Clear()

Removes all persons from the collection

public void Clear()

Find(Predicate<ExcelThreadedCommentPerson>)

Finds a ExcelThreadedCommentPerson that match a certain criteria

public ExcelThreadedCommentPerson Find(Predicate<ExcelThreadedCommentPerson> match)

Parameters

match Predicate<ExcelThreadedCommentPerson>

The criterias

Returns

ExcelThreadedCommentPerson

A matching ExcelThreadedCommentPerson

FindAll(Predicate<ExcelThreadedCommentPerson>)

Finds a number of ExcelThreadedCommentPerson's that matches a certain criteria.

public IEnumerable<ExcelThreadedCommentPerson> FindAll(Predicate<ExcelThreadedCommentPerson> match)

Parameters

match Predicate<ExcelThreadedCommentPerson>

The criterias

Returns

IEnumerable<ExcelThreadedCommentPerson>

An enumerable of matching ExcelThreadedCommentPerson's

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<ExcelThreadedCommentPerson> GetEnumerator()

Returns

IEnumerator<ExcelThreadedCommentPerson>

An enumerator that can be used to iterate through the collection.

Remove(ExcelThreadedCommentPerson)

Removes a ExcelThreadedCommentPerson from the collection

public void Remove(ExcelThreadedCommentPerson person)

Parameters

person ExcelThreadedCommentPerson

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.