View Source

Interface IGridCellValueConnector2

Namespace: Umbraco.Cms.Core.Deploy

Assembly: Umbraco.Infrastructure.dll

Syntax

public interface IGridCellValueConnector2 : IGridCellValueConnector

Remarks

This interface will be merged back into IGridCellValueConnector and removed in Umbraco 13.

Methods

GetValue(GridValue.GridControl, ICollection<ArtifactDependency>, IContextCache)

Gets the value to be deployed from the control value as a string.

Declaration

string GetValue(GridValue.GridControl gridControl, ICollection<ArtifactDependency> dependencies, IContextCache contextCache)

Parameters

Type	Name	Description
GridValue.GridControl	gridControl	The control containing the value.
ICollection<ArtifactDependency>	dependencies	The dependencies of the property.
IContextCache	contextCache	The context cache.

Returns

Type	Description
System.String	The grid cell value to be deployed.

SetValue(GridValue.GridControl, IContextCache)

Allows you to modify the value of a control being deployed.

Declaration

void SetValue(GridValue.GridControl gridControl, IContextCache contextCache)

Parameters

Type	Name	Description
GridValue.GridControl	gridControl	The control being deployed.
IContextCache	contextCache	The context cache.

Remarks

Follows the pattern of the property value connectors (IValueConnector). The SetValue method is used to modify the value of the gridControl.

Explicit Interface Implementations

IGridCellValueConnector.GetValue(GridValue.GridControl, ICollection<ArtifactDependency>)

Gets the value to be deployed from the control value as a string.

Declaration

string IGridCellValueConnector.GetValue(GridValue.GridControl gridControl, ICollection<ArtifactDependency> dependencies)

Parameters

Type	Name	Description
GridValue.GridControl	gridControl	The control containing the value.
ICollection<ArtifactDependency>	dependencies	The dependencies of the property.

Returns

Type	Description
System.String	The grid cell value to be deployed.

Remarks

Note that

IGridCellValueConnector.SetValue(GridValue.GridControl)

Allows you to modify the value of a control being deployed.

Declaration

void IGridCellValueConnector.SetValue(GridValue.GridControl gridControl)

Parameters

Type	Name	Description
GridValue.GridControl	gridControl	The control being deployed.

Remarks

Follows the pattern of the property value connectors (IValueConnector). The SetValue method is used to modify the value of the gridControl.