Class VariationExtensions

Class that provides methods for variations

Inheritance

System.Object

VariationExtensions

Namespace: Microsoft.SharePoint.Client

Assembly: PnP.Framework.dll

Syntax

public static class VariationExtensions : object

Methods

ConfigureVariationsSettings(ClientContext, VariationInformation)

Configures the variation settings

1. Go to "Site Actions" -> "Site settings"
2. Under "Site collection administration", click "Variation Settings". This method is for the page above to change or update the "Variation Settings"

Declaration

public static void ConfigureVariationsSettings(this ClientContext context, VariationInformation variationSettings)

Parameters

ClientContext context Context for SharePoint objects and operations

VariationInformation variationSettings Variation settings

GetVariationLabels(ClientContext)

Retrieve all configured variation labels

Declaration

public static IEnumerable<VariationLabelEntity> GetVariationLabels(this ClientContext context)

Parameters

ClientContext context Context for SharePoint objects and operations

Returns

IEnumerable<VariationLabelEntity> Collection of VariationLabelEntity objects

ProvisionSourceVariationLabel(ClientContext, VariationLabelEntity)

Creates source variation label

Declaration

public static void ProvisionSourceVariationLabel(this ClientContext context, VariationLabelEntity sourceVariationLabel)

Parameters

ClientContext context Context for SharePoint objects and operations

VariationLabelEntity sourceVariationLabel Source variation label

ProvisionTargetVariationLabels(ClientContext, List<VariationLabelEntity>)

Creates target variation labels

Declaration

public static void ProvisionTargetVariationLabels(this ClientContext context, List<VariationLabelEntity> variationLabels)

Parameters

ClientContext context Context for SharePoint objects and operations

List<VariationLabelEntity> variationLabels Variation labels

WaitForVariationLabelCreation(ClientContext, VariationLabelEntity)

Wait for the variation label creation

Declaration

public static void WaitForVariationLabelCreation(this ClientContext context, VariationLabelEntity variationLabel)

Parameters

ClientContext context Context for SharePoint objects and operations

VariationLabelEntity variationLabel Variation label