Class ExcelThreadedCommentPersonCollection

Represents a collection of ExcelThreadedCommentPersons in a workbook.

Inheritance

System.Object

ExcelThreadedCommentPersonCollection

Implements

System.Collections.Generic.IEnumerable<ExcelThreadedCommentPerson>

System.Collections.IEnumerable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: OfficeOpenXml.ThreadedComments

Assembly: EPPlus.dll

Syntax

public class ExcelThreadedCommentPersonCollection : IEnumerable<ExcelThreadedCommentPerson>, IEnumerable

Constructors

ExcelThreadedCommentPersonCollection(ExcelWorkbook)

Constructor

Declaration

public ExcelThreadedCommentPersonCollection(ExcelWorkbook workbook)

Parameters

Type	Name	Description
ExcelWorkbook	workbook	The workbook where the ExcelThreadedCommentPerson occurs

Properties

Count

Number of ExcelThreadedCommentPersons in the collection

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Item[Int32]

Returns the ExcelThreadedCommentPerson by its index

Declaration

public ExcelThreadedCommentPerson this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index	The requested index

Property Value

Type	Description
ExcelThreadedCommentPerson	The ExcelThreadedCommentPerson at the requested index

Item[String]

Returns a ExcelThreadedCommentPerson by its id

Declaration

public ExcelThreadedCommentPerson this[string id] { get; }

Parameters

Type	Name	Description
System.String	id	The Id of the Person

Property Value

Type	Description
ExcelThreadedCommentPerson	A ExcelThreadedCommentPerson with the requested id or null

PersonsXml

The xml document defining the threaded comments persons collection.

Declaration

public XmlDocument PersonsXml { get; }

Property Value

Type	Description
System.Xml.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

Declaration

public ExcelThreadedCommentPerson Add(string displayName)

Parameters

Type	Name	Description
System.String	displayName	The display name of the added ExcelThreadedCommentPerson

Returns

Type	Description
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.

Declaration

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

Parameters

Type	Name	Description
System.String	displayName	The display name of the added ExcelThreadedCommentPerson
System.String	userId	A string representing the userId of the identityProvider
IdentityProvider	identityProvider	The IdentityProvider from which the ExcelThreadedCommentPerson originates

Returns

Type	Description
ExcelThreadedCommentPerson	The added ExcelThreadedCommentPerson

Add(String, String, IdentityProvider, String)

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

Declaration

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

Parameters

Type	Name	Description
System.String	displayName	The display name of the added ExcelThreadedCommentPerson
System.String	userId	A string representing the userId of the identityProvider
IdentityProvider	identityProvider	The IdentityProvider from which the ExcelThreadedCommentPerson originates
System.String	id	Id of the ExcelThreadedCommentPerson

Returns

Type	Description
ExcelThreadedCommentPerson	The added ExcelThreadedCommentPerson

Clear()

Removes all persons from the collection

Declaration

public void Clear()

Find(Predicate<ExcelThreadedCommentPerson>)

Finds a ExcelThreadedCommentPerson that match a certain criteria

Declaration

public ExcelThreadedCommentPerson Find(Predicate<ExcelThreadedCommentPerson> match)

Parameters

Type	Name	Description
System.Predicate<ExcelThreadedCommentPerson>	match	The criterias

Returns

Type	Description
ExcelThreadedCommentPerson	A matching ExcelThreadedCommentPerson

FindAll(Predicate<ExcelThreadedCommentPerson>)

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

Declaration

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

Parameters

Type	Name	Description
System.Predicate<ExcelThreadedCommentPerson>	match	The criterias

Returns

Type	Description
System.Collections.Generic.IEnumerable<ExcelThreadedCommentPerson>	An enumerable of matching ExcelThreadedCommentPerson's

GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

public IEnumerator<ExcelThreadedCommentPerson> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<ExcelThreadedCommentPerson>	An enumerator that can be used to iterate through the collection.

Remove(ExcelThreadedCommentPerson)

Removes a ExcelThreadedCommentPerson from the collection

Declaration

public void Remove(ExcelThreadedCommentPerson person)

Parameters

Type	Name	Description
ExcelThreadedCommentPerson	person

ToString()

Returns a string that represents the current object.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A string that represents the current object.

Overrides

System.Object.ToString()

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through the collection.

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator	An enumerator that can be used to iterate through the collection.

Implements

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable