View Source

Interface IGridCellValueConnector

Defines methods that can convert a grid cell value to / from an environment-agnostic string.

Namespace: Umbraco.Cms.Core.Deploy

Assembly: Umbraco.Infrastructure.dll

Syntax

public interface IGridCellValueConnector

Remarks

Grid cell values may contain values such as content identifiers, that would be local to one environment, and need to be converted in order to be deployed.

Methods

GetValue(GridValue.GridControl, ICollection<ArtifactDependency>)

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

Declaration

string 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

IsConnector(String)

Gets a value indicating whether the connector supports a specified grid editor view.

Declaration

bool IsConnector(string view)

Parameters

Type	Name	Description
System.String	view	The grid editor view. It needs to be the view instead of the alias as the view is really what identifies what kind of connector should be used. Alias can be anything and you can have multiple different aliases using the same kind of view.

Returns

Type	Description
System.Boolean	true if the specified view is connector; otherwise, false.

Remarks

A value indicating whether the connector supports the grid editor view.

SetValue(GridValue.GridControl)

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

Declaration

void 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.