MFGS ReportingSSRS Server Collection

MFGSReportingSSRSServerCollection Public interface

Description

Describes a collection of SSRS servers.

Diagram

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

Members

Properties

Public properties

Type	Name	Methods
int	Count The number of servers in the collection.	get
IExMFGSReportingSSRSServer	Item	get

Methods

Public methods

Returns	Name
IExMFGSReportingSSRSServer	Add(string name, string reportServerURL, MFGSHttpClientCredentialType credentialType, string userName, string password, string domain) adds a server to the collection.
void	Clear() Clears the collection.
bool	Contains(string name) Indicates if a server with the specified name is in the collection.
bool	Remove(string name) Removes a server from the collection.
void	RemoveAt(int index) Removes a server from the collection.

Details

Summary

Describes a collection of SSRS servers.

Methods

Clear

public void Clear()

Summary

Clears the collection.

Add

public IExMFGSReportingSSRSServer Add(string name, string reportServerURL, MFGSHttpClientCredentialType credentialType, string userName, string password, string domain)

Arguments

Type	Name	Description
string	name	The name of the server.
string	reportServerURL	The URL of the report server.
MFGSHttpClientCredentialType	credentialType	The type of credentials to use when connecting.
string	userName	The user name for the credentials.
string	password	The password for the credentials.
string	domain	The domain for the credentials.

Summary

adds a server to the collection.

Remarks

The name of the server has no direct correlation to SSRS and is only used to reference the report in code.

Returns

An IExMFGSReportingSSRSServer object representing the server.

Contains

public bool Contains(string name)

Arguments

Type	Name	Description
string	name	The name of the server.

Summary

Indicates if a server with the specified name is in the collection.

Remarks

name is case-insensitive.

Returns

true if the server name exists, otherwise false.

Remove

public bool Remove(string name)

Arguments

Type	Name	Description
string	name	The name of the server.

Summary

Removes a server from the collection.

Remarks

name is case-insensitive.

Returns

true if the server was found and removed; otherwise false.

RemoveAt

public void RemoveAt(int index)

Arguments

Type	Name	Description
int	index	The index at which to remove the server.

Summary

Removes a server from the collection.

Properties

Count

public int Count { get; }

Summary

The number of servers in the collection.

Item

public IExMFGSReportingSSRSServer Item { get; }

Generated with ModularDoc