Skip to content

Commit c23fec4

Browse files
authored
Update Overview.md
minor formatting and typo corrections
1 parent 0208c61 commit c23fec4

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed
Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
# CodeFactory Commands
22
When working with CodeFactory you always start with commands.
3-
Commands are the trigger point where all CodeFactory functionality starts from.
4-
Currently all commands are triggered from context menus on individual nodes within solution explorer. Each ommand is made up of two methods that are raised from internal events that occur within Visual Studio itself. These events are trigged when a selected solution explorers item content menu is opened.
5-
The following describes the two methods, their goals and the different type of commands that are supported in CodeFactory.
3+
Commands are the trigger point where all CodeFactory functionality originates.
4+
Currently all commands are triggered from context menus on individual nodes within Solution Explorer. Each command is comprised of two methods which are raised from internal events that occur within Visual Studio. These events are trigged when a selected Solution Explorer's item content menu is opened.
5+
The following describes each of the two methods, their purpose and the different types of commands that are supported in CodeFactory.
66

77
## Command Result
8-
Whenever a command is executed a real time data model is generated based on the type of Visual Studio object that has been selected. The data model is regenerated each time the target command is executed.
8+
Whenever a command is executed, a real time data model is generated based on the type of Visual Studio object that has been selected. The data model is instantly regenerated behind-the-scenes each time the target command is executed.
99

1010
## Enable Command
11-
When a command is first loaded it sends the command result to the enable method on the command.
12-
This method is called to allow the author of the command to determine if the command should be visible to the automation user for use.
11+
When a command is first loaded, it sends the command result to the enable method on the command.
12+
This method is called to allow the author of the command to determine whether the command should be visible or hidden to the automation user for use.
1313
This feature exists in order to allow automation authors to control execution of automation by hiding or showing commands on the context menu as they desire.
1414

1515
This is controlled by simply returning a true or false value to determine if the command should be accessible.
16-
If enabled is true the command will show up in the context menu.
16+
If enabled is true, the command will appear inside the context menu.
1717
The developer in Visual Studio can then trigger the command to execute by selecting the context menu item.
1818

1919
## Execute Command
20-
Once the developer selects a command to be executed Visual Studio will run the execute method of the command itself.
21-
Like before a real time data model is passed to the execute method.
22-
This is where the automation process starts and whatever functionality has been authored will executed at this time.
20+
Once the developer selects a command to be executed, Visual Studio will run the execute method of the command itself.
21+
Like before, a real time data model is instantly passed to the execute method.
22+
This is when the automation process starts, and whatever functionality has been authored, will be executed at this time.
2323

24-
## Solution Explore Commands
25-
CodeFactory current supports the trigger of commands from the Solution Explorer window in Visual Studio.
26-
The following are the supported Solution Explorer nodes that will CodeFactory Automation.
24+
## Solution Explorer Commands
25+
CodeFactory current supports the trigger of commands from the Solution Explorer window within Visual Studio.
26+
The following are the supported Solution Explorer nodes that can interact with CodeFactory automation commands:
2727

28-
- Solution Command - Generates a Solutiuon data model
29-
- SolutionFolder Command - Generates a Solution Folder data model
30-
- SolutionDocument Command - Generates a Document data model
28+
- Solution Command - Generates a Solution data model
29+
- SolutionFolder Command - Generates a SolutionFolder data model
30+
- SolutionDocument Command - Generates a SolutionDocument data model
3131
- Project Command - Generates a Project data model
32-
- Project Folder - Generates a Project Folder data model
32+
- ProjectFolder - Generates a ProjectFolder data model
3333
- Document Command - Generates a Document data model
3434
- C# Document Command - Generates a CSharpSource data model

0 commit comments

Comments
 (0)