MFGS ReportingSSRS Report Collection

MFGSReportingSSRSReportCollection `Public interface`

Description

Describes a collection of SSRS reports on a server.

Diagram

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

Members

Properties

Public properties

Type	Name	Methods
`int`	`Count` The number of reports in the collection.	`get`
`IExMFGSReportingSSRSReport`	`Item`	`get`

Methods

Public methods

Returns	Name
`IExMFGSReportingSSRSReport`	`Add`(`string` name, `string` reportPath) Adds a report to the collection.
`void`	`Clear`() clears the collection.
`bool`	`Contains`(`string` name) Indicates if a report with the specified name is in the collection.
`bool`	`Remove`(`string` name) Removes a report from the collection.
`void`	`RemoveAt`(`int` index) Removes a report from the collection.

Details

Summary

Describes a collection of SSRS reports on a server.

Methods

Clear

public void Clear()

Summary

clears the collection.

Add

public IExMFGSReportingSSRSReport Add(string name, string reportPath)

Arguments

Type	Name	Description
`string`	name	The name to be used to identify this report.
`string`	reportPath	The SSRS report path

Summary

Adds a report to the collection.

Remarks

The name of the report has not direct correlation to SSRS and is only used to reference the report in code. If a report with the same name already exists in the collection, the reportPath of the existing report will be updated. name is case-insensitive.

Returns

An IExMFGSReportingSSRSReport object representing the report.

Contains

public bool Contains(string name)

Arguments

Type	Name	Description
`string`	name	The name of the report.

Summary

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

Remarks

name is case-insensitive.

Returns

true if the report name exists, otherwise false.

Remove

public bool Remove(string name)

Arguments

Type	Name	Description
`string`	name	The name of the report.

Summary

Removes a report from the collection.

Remarks

name is case-insensitive.

Returns

true if the report 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 report.

Summary

Removes a report from the collection.

Properties

Count

public int Count { get; }

Summary

The number of reports in the collection.

Item

public IExMFGSReportingSSRSReport Item { get; }

Generated with ModularDoc

MFGS ReportingSSRS Report Collection