 |
| IXlsScenario |
|
COM interface ( getting help with interfaces )
interface IXlsScenario : IDispatch
{
[id(1),propput] HRESULT ScenarioName([in]BSTR scenarioname);
[id(1),propget] HRESULT ScenarioName([out, retval]BSTR* scenarioname);
[id(2),propput] HRESULT ScenarioCreatedBy([in]BSTR scenariocreatedby);
[id(2),propget] HRESULT ScenarioCreatedBy([out, retval]BSTR* scenariocreatedby);
[id(3),propput] HRESULT ScenarioComment([in]BSTR scenariocomment);
[id(3),propget] HRESULT ScenarioComment([out, retval]BSTR* scenariocomment);
[id(4),propput] HRESULT ScenarioResultCellsRange([in]BSTR scenarioresultcells);
[id(4),propget] HRESULT ScenarioResultCellsRange([out, retval]BSTR* scenarioresultcells);
[id(5),propput] HRESULT ScenarioPreventCellChanges([in]BOOL protection);
[id(5),propget] HRESULT ScenarioPreventCellChanges([out, retval] BOOL* protection);
[id(6),propput] HRESULT ScenarioCellHidden([in]BOOL protection);
[id(6),propget] HRESULT ScenarioCellHidden([out, retval] BOOL* protection);
[id(7)] HRESULT ScenarioAddValue([out, retval]IXlsScenarioValue** scenariovalue);
[id(8),propget] HRESULT ScenarioValueItem([in]int i, [out, retval]IXlsScenarioValue** scenariovalue);
[id(9),propget] HRESULT ScenarioValueCount([out, retval]int* scenariovaluecount);
[id(10),propget] HRESULT ScenarioResultValue([out, retval]IXlsScenarioValue** result);
[id(11)] HRESULT ScenarioSelect();
}
HRESULT ScenarioName([in]BSTR scenarioname);
sets a name for the scenario. Mandatory.
HRESULT ScenarioName([out, retval]BSTR* scenarioname);
returns a name for the scenario.
HRESULT ScenarioCreatedBy([in]BSTR scenariocreatedby);
sets a creator name for the scenario. Optional.
HRESULT ScenarioCreatedBy([out, retval]BSTR* scenariocreatedby);
returns a creator name for the scenario.
HRESULT ScenarioComment([in]BSTR scenariocomment);
sets a comment for the scenario. Optional.
HRESULT ScenarioComment([out, retval]BSTR* scenariocomment);
returns a comment for the scenario.
HRESULT ScenarioResultCellsRange([in]BSTR scenarioresultcells);
sets the result cells range for the scenario.
HRESULT ScenarioResultCellsRange([out, retval]BSTR* scenarioresultcells);
returns the result cells range for the scenario.
HRESULT ScenarioPreventCellChanges([in]BOOL protection);
sets whether the cells can change when the sheet is protected.
HRESULT ScenarioPreventCellChanges([out, retval] BOOL* protection);
returns whether the cells can change when the sheet is protected.
HRESULT ScenarioCellHidden([in]BOOL protection);
sets whether the cells are hidden when the sheet is protected.
HRESULT ScenarioCellHidden([out, retval] BOOL* protection);
returns whether the cells are hidden when the sheet is protected.
HRESULT ScenarioAddValue([out, retval]IXlsScenarioValue** scenariovalue);
adds a scenario value object. Changing a value is part of what makes a scenario. There are input values causing changes in output (result) values.
HRESULT ScenarioValueItem([in]int i, [out, retval]IXlsScenarioValue** scenariovalue);
returns the i-th scenario value object. Changing a value is part of what makes a scenario. There are input values causing changes in output (result) values. Index begins at 1.
HRESULT ScenarioValueCount([out, retval]int* scenariovaluecount);
returns the number of scenario values.
HRESULT ScenarioResultValue([out, retval]IXlsScenarioValue** result);
returns the value of a cell after the scenario is applied.
HRESULT ScenarioSelect();
selects the scenario.