SandcastleProject.EnsureProjectIsCurrent Method

SandcastleProjectEnsureProjectIsCurrent Method

This is used to ensure that all local collection project properties have been stored in the MSBuild project file and that path-type properties are current based on the current project location.

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public void EnsureProjectIsCurrent(
	bool forceUpdate
)

Public Sub EnsureProjectIsCurrent ( 
	forceUpdate As Boolean
)

public:
void EnsureProjectIsCurrent(
	bool forceUpdate
)

member EnsureProjectIsCurrent : 
        forceUpdate : bool -> unit

Parameters

forceUpdate: Type: SystemBoolean
True to force an update of all affected properties or false to only update those that need it.

Remarks

This only affects the property-based collection properties and path-type properties. Simple types and item group element properties are stored when modified. This will also ensure that the SHFBSchemaVersion is set to the current version too.

Reference

SandcastleProject Class

SandcastleBuilder.Utils Namespace