RetrieveEntityRequest.RetrieveAsIfPublished Property


Applies To: Dynamics CRM 2015

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

Namespace:   Microsoft.Xrm.Sdk.Messages
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)


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

Property Value

Type: System.Boolean

Type: Boolean
true if the metadata that has not been published should be retrieved; otherwise, false.


If you are creating an entity editor you will need to retrieve entity 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.

See Also

RetrieveEntityRequest Class
Microsoft.Xrm.Sdk.Messages Namespace

Return to top

© 2016 Microsoft. All rights reserved. Copyright