SandcastleProject.QueryEditProjectFile Event

SandcastleProjectQueryEditProjectFile Event

This event is raised when a property is about to be changed to see if the project file can be edited.

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

Syntax

C++

Copy

public event EventHandler<CancelEventArgs> QueryEditProjectFile

Public Event QueryEditProjectFile As EventHandler(Of CancelEventArgs)

public:
 event EventHandler<CancelEventArgs^>^ QueryEditProjectFile {
	void add (EventHandler<CancelEventArgs^>^ value);
	void remove (EventHandler<CancelEventArgs^>^ value);
}

member QueryEditProjectFile : IEvent<EventHandler<CancelEventArgs>,
    CancelEventArgs>

Value

Type: SystemEventHandlerCancelEventArgs

Remarks

If the project file cannot be edited, the handler should cancel the event so that the property is not changed.

Reference

SandcastleProject Class

SandcastleBuilder.Utils Namespace