RetrieveOptionSetRequest.RetrieveAsIfPublished Property

  • Reference

Definition

Namespace:
Microsoft.Xrm.Sdk.Messages
Assembly:
Microsoft.Xrm.Sdk.dll
Package:
Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Gets or sets whether to retrieve the metadata that has not been published. Required. 

public:
 property bool RetrieveAsIfPublished { bool get(); void set(bool value); };
public bool RetrieveAsIfPublished { get; set; }
member this.RetrieveAsIfPublished : bool with get, set
Public Property RetrieveAsIfPublished As Boolean

Property Value

Boolean

true if the the unpublished metadata should be retrieved; otherwise, false.

Remarks

If you are creating a global option set editor you will need to retrieve data that has been saved but not published. For other scenarios you will want to only retrieve published metadata.

  • Set this value to true to include unpublished changes, as it would look if you called publish.

  • Set this value to false to include only the currently published changes, ignoring the changes that haven't yet been published.

Applies to