Documentation

Class ToggleVisibilityAction

Represents an interactive action that toggles the visibility of one or more items / groups.

Inheritance
System.Object
ToggleVisibilityAction
Namespace: Telerik.Reporting
Assembly: Telerik.Reporting.dll

Syntax

public class ToggleVisibilityAction : IAction, IEquatable<ToggleVisibilityAction>, IActionWithTargets
Remarks

Use this action to specify an interactive action on a report item that toggles the visibility of one or more items / groups (drilldown).

When this action is set on an item, the item is rendered with an expand / collapse mark in all report viewers. Clicking on that mark triggers the action.

Constructors

ToggleVisibilityAction()

Creates a new instance of the ToggleVisibilityAction class.

Declaration
public ToggleVisibilityAction()

ToggleVisibilityAction(IActionTarget, Boolean)

Creates a new instance of the ToggleVisibilityAction class with the specified toggle visibility target and initial toggle mark state.

Declaration
public ToggleVisibilityAction(IActionTarget target, bool displayExpandedMark)
Parameters
IActionTarget target

The Name GroupBase.Name of the toggle visibility target.
System.Boolean displayExpandedMark

The initial toggle visibility mark of the item.

ToggleVisibilityAction(IActionTarget[], Boolean)

Creates a new instance of the ToggleVisibilityAction class with specified toggle visibility targets and initial toggle mark state.

Declaration
public ToggleVisibilityAction(IActionTarget[] targets, bool displayExpandedMark)
Parameters
IActionTarget[] targets

An enumerable of Name GroupBase.Name of the toggle visibility targets.
System.Boolean displayExpandedMark

The initial toggle visibility mark of the item.

Properties

DisplayExpandedMark

Determines if the item exposing the action will be rendered initially with expanded or with collapsed mark.

Declaration
public bool DisplayExpandedMark { get; set; }
Property Value
System.Boolean

Remarks

A true value will determine an expanded mark to be rendered (minus sign). A false value will determine an collapsed mark to be rendered (plus sign).

Targets

Gets the list of toggle targets which visibility will be toggled when the action is triggered.

Declaration
public ActionTargetCollection Targets { get; }
Property Value
ActionTargetCollection

Remarks

Use this property to add / remove toggle targets of the action. To add an item / report group / table group as toggle target you need to add / remove the value of the Name / GroupBase.Name GroupBase.Name of the target respectively. The used names must be unique in the report scope.

The items in this list do not accept expressions.

Methods

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

Overrides
System.Object.Equals(System.Object)

Equals(ToggleVisibilityAction)

Declaration
public bool Equals(ToggleVisibilityAction other)
Parameters
ToggleVisibilityAction other

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

Overrides
System.Object.GetHashCode()