MFGS Email Address Collection

MFGSEmailAddressCollection Public interface

Description

Represents a collection of addresses

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph VGWWCoreIEx
  VGWWCoreIEx.IExMFGSEmailAddressCollection[[IExMFGSEmailAddressCollection]]
  class VGWWCoreIEx.IExMFGSEmailAddressCollection interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
int	Count Gets the number of addresses contained in the collection.	get
IExMFGSEmailAddress	Item	get

Methods

Public methods

Returns	Name
void	Add(string address, string name) Add an address to the collection
void	Clear() Clear the address collection.
string	Join(string separator, MFGSEmailAddressField field) Concatenates all addresses in the collection into a single string.
void	ParseAdd(string addressList) Add multiple addresses to the collection.
bool	Remove(string addressOrName, MFGSEmailAddressField field, bool ignoreCase) Remove the specified address from the collection.
void	RemoveAt(int index) Remove the address at the specified index from the collection.

Details

Summary

Represents a collection of addresses

Methods

Clear

public void Clear()

Summary

Clear the address collection.

Join

public string Join(string separator, MFGSEmailAddressField field)

Arguments

Type	Name	Description
string	separator	The separator between each address
MFGSEmailAddressField	field	The field of the address to use

Summary

Concatenates all addresses in the collection into a single string.

Returns

Add

public void Add(string address, string name)

Arguments

Type	Name	Description
string	address	The address
string	name	The name

Summary

Add an address to the collection

ParseAdd

public void ParseAdd(string addressList)

Arguments

Type	Name	Description
string	addressList	A semi-colon (;) delimited list of addresses.

Summary

Add multiple addresses to the collection.

Remove

public bool Remove(string addressOrName, MFGSEmailAddressField field, bool ignoreCase)

Arguments

Type	Name	Description
string	addressOrName	The name or address to remove.
MFGSEmailAddressField	field	The field to check.
bool	ignoreCase	Determine if case should be ignored.

Summary

Remove the specified address from the collection.

Returns

RemoveAt

public void RemoveAt(int index)

Arguments

Type	Name	Description
int	index	The index of the address.

Summary

Remove the address at the specified index from the collection.

Properties

Count

public int Count { get; }

Summary

Gets the number of addresses contained in the collection.

Item

public IExMFGSEmailAddress Item { get; }

Generated with ModularDoc