PropagateInstrumentChange()

View as Markdown

Definition

In an NTWindow, PropagateInstrumentChange() sends an Instrument to other windows with the same Instrument Linking color configured.

  • A public Instrument property must be defined in order to use PropagateInstrumentChange(), as in the example below.
  • A public Instrument property must be defined in order to use PropagateInstrumentChange(), as in the example below.
  • For a complete, working example of this class in use, download framework example located on our Developing AddOns Overview.

Examples

1// IInstrumentProvider member. Required if you want to use the instrument link mechanism on an NTWindow.
2public Cbi.Instrument Instrument
3{
4 get { return instrument; }
5 set
6 {
7 // Process logic related to switching instruments, such as:
8 // Unsubscribe to subscriptions to old instruments...
9 // Subscribe for the new instrument...
10 // Change the value displayed in an Instrument Selector in the NTWindow...
11 // Update the tab header name on AddOnFramework to be the same name as the new instrument...
12 // etc...
13
14 // Send instrument to other windows linked to the same color
15 PropagateInstrumentChange(value);
16 }
17}