POST api/StringsSetout/ContextMenuItemSelected

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DesignMode	integer	None.
MenuId	integer	None.
MenuName	string	None.
IMenuInd	integer	None.
IUnitInd	integer	None.
IItemId	integer	None.
CanvasHeight	integer	None.
CanvasWidth	integer	None.
UserInput	string	None.
ListIndex	integer	None.
MouseX	integer	None.
MouseY	integer	None.
ClickX	integer	None.
ClickY	integer	None.
YesNo	boolean	None.
KeyPress	KeyPressParameters	None.
NotificationResponse	NotificationResponseDto	None.
GCat	integer	None.
Caption	string	None.
CtrlPress	boolean	None.
FileName	string	None.
Extension	string	None.

Request Formats

application/json, text/json

Sample:

{
  "designMode": 1,
  "menuId": 2,
  "menuName": "sample string 3",
  "iMenuInd": 4,
  "iUnitInd": 5,
  "iItemId": 6,
  "canvasHeight": 7,
  "canvasWidth": 8,
  "userInput": "sample string 9",
  "listIndex": 10,
  "mouseX": 11,
  "mouseY": 12,
  "clickX": 13,
  "clickY": 14,
  "yesNo": true,
  "keyPress": {
    "ctrlKey": true,
    "shiftKey": true,
    "altKey": true
  },
  "notificationResponse": {
    "responseType": 0,
    "value": "sample string 1",
    "identifier": "sample string 2"
  },
  "gCat": 16,
  "caption": "sample string 17",
  "ctrlPress": true,
  "fileName": "sample string 19",
  "extension": "sample string 20"
}

application/xml, text/xml

Sample:

<ContextMenuSelectedItemParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
  <CanvasHeight>7</CanvasHeight>
  <CanvasWidth>8</CanvasWidth>
  <Caption>sample string 17</Caption>
  <ClickX>13</ClickX>
  <ClickY>14</ClickY>
  <CtrlPress>true</CtrlPress>
  <DesignMode>1</DesignMode>
  <Extension>sample string 20</Extension>
  <FileName>sample string 19</FileName>
  <GCat>16</GCat>
  <IItemId>6</IItemId>
  <IMenuInd>4</IMenuInd>
  <IUnitInd>5</IUnitInd>
  <KeyPress>
    <AltKey>true</AltKey>
    <CtrlKey>true</CtrlKey>
    <ShiftKey>true</ShiftKey>
  </KeyPress>
  <ListIndex>10</ListIndex>
  <MenuId>2</MenuId>
  <MenuName>sample string 3</MenuName>
  <MouseX>11</MouseX>
  <MouseY>12</MouseY>
  <NotificationResponse>
    <Identifier>sample string 2</Identifier>
    <ResponseType>Null</ResponseType>
    <Value>sample string 1</Value>
  </NotificationResponse>
  <UserInput>sample string 9</UserInput>
  <YesNo>true</YesNo>
</ContextMenuSelectedItemParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

StringSetoutViewModel

Name	Type	Additional information
EditMode	integer	None.
MainDrawing	string	None.
StgPrevNextButtonSelected	integer	None.
TenonCountLabel	string	None.
WallCountLabel	string	None.
ZoomParameter	ZoomParameterDto	None.
Notification	NotificationDto	None.
Theme	string	None.
BackGroundColor	string	None.
isReverse	boolean	None.
TenonPreviousButton	CommandButtonDto	None.
TenonNextButton	CommandButtonDto	None.
WallPreviousButton	CommandButtonDto	None.
WallNextButton	CommandButtonDto	None.
ShowDoneCheckBox	CheckBoxDto	None.
DoneHiCheckBox	CheckBoxDto	None.
DoneHiCheckBoxLeft	string	None.
DoneLoCheckBox	CheckBoxDto	None.
DoneLoCheckBoxLeft	string	None.
ClearUnitButton	CommandButtonDto	None.
ClearStairButton	CommandButtonDto	None.
SelectExtendHi	DropDownBoxDto	None.
SelectExtendLo	DropDownBoxDto	None.

Response Formats

application/json, text/json

Sample:

{
  "tenonPreviousButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "tenonNextButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "wallPreviousButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "wallNextButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "showDoneCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "doneHiCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "doneHiCheckBoxLeft": "sample string 1",
  "doneLoCheckBox": {
    "checked": true,
    "visible": true,
    "enabled": true,
    "caption": "sample string 4"
  },
  "doneLoCheckBoxLeft": "sample string 2",
  "clearUnitButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "clearStairButton": {
    "visible": true,
    "enabled": true,
    "caption": "sample string 3"
  },
  "selectExtendHi": {
    "visible": true,
    "enabled": true,
    "items": [
      "sample string 1",
      "sample string 2"
    ],
    "guids": [
      "e414321f-258e-49fe-9161-daeb54d7b0e2",
      "35a1debe-baa6-4f1a-84b0-72be3d78a875"
    ],
    "selectedIndex": 1,
    "selectedItem": "sample string 3",
    "filterUid": "51d135de-907e-462f-95c4-f63bb44ce66b"
  },
  "selectExtendLo": {
    "visible": true,
    "enabled": true,
    "items": [
      "sample string 1",
      "sample string 2"
    ],
    "guids": [
      "e414321f-258e-49fe-9161-daeb54d7b0e2",
      "35a1debe-baa6-4f1a-84b0-72be3d78a875"
    ],
    "selectedIndex": 1,
    "selectedItem": "sample string 3",
    "filterUid": "51d135de-907e-462f-95c4-f63bb44ce66b"
  },
  "editMode": 1,
  "mainDrawing": "sample string 2",
  "stgPrevNextButtonSelected": 3,
  "tenonCountLabel": "sample string 4",
  "wallCountLabel": "sample string 5",
  "zoomParameter": {
    "startX": 1,
    "startY": 2,
    "endX": 3,
    "endY": 4,
    "canvasHeight": 5,
    "canvasWidth": 6,
    "ctrlPress": true
  },
  "notification": {
    "title": "sample string 1",
    "description": "sample string 2",
    "type": 0,
    "identifier": "sample string 3"
  },
  "theme": "sample string 6",
  "backGroundColor": "sample string 7",
  "isReverse": true
}

application/xml, text/xml

Sample:

<StringSetoutViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <BackGroundColor>sample string 7</BackGroundColor>
  <ClearStairButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </ClearStairButton>
  <ClearUnitButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </ClearUnitButton>
  <DoneHiCheckBox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 4</d2p1:Caption>
    <d2p1:Checked>true</d2p1:Checked>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </DoneHiCheckBox>
  <DoneHiCheckBoxLeft>sample string 1</DoneHiCheckBoxLeft>
  <DoneLoCheckBox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 4</d2p1:Caption>
    <d2p1:Checked>true</d2p1:Checked>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </DoneLoCheckBox>
  <DoneLoCheckBoxLeft>sample string 2</DoneLoCheckBoxLeft>
  <EditMode>1</EditMode>
  <MainDrawing>sample string 2</MainDrawing>
  <Notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Common">
    <d2p1:_x003C_Description_x003E_k__BackingField>sample string 2</d2p1:_x003C_Description_x003E_k__BackingField>
    <d2p1:_x003C_Identifier_x003E_k__BackingField>sample string 3</d2p1:_x003C_Identifier_x003E_k__BackingField>
    <d2p1:_x003C_Title_x003E_k__BackingField>sample string 1</d2p1:_x003C_Title_x003E_k__BackingField>
    <d2p1:_x003C_Type_x003E_k__BackingField>Default</d2p1:_x003C_Type_x003E_k__BackingField>
  </Notification>
  <SelectExtendHi xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:FilterUid>51d135de-907e-462f-95c4-f63bb44ce66b</d2p1:FilterUid>
    <d2p1:Guids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>e414321f-258e-49fe-9161-daeb54d7b0e2</d3p1:guid>
      <d3p1:guid>35a1debe-baa6-4f1a-84b0-72be3d78a875</d3p1:guid>
    </d2p1:Guids>
    <d2p1:Items xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Items>
    <d2p1:SelectedIndex>1</d2p1:SelectedIndex>
    <d2p1:SelectedItem>sample string 3</d2p1:SelectedItem>
    <d2p1:Visible>true</d2p1:Visible>
  </SelectExtendHi>
  <SelectExtendLo xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:FilterUid>51d135de-907e-462f-95c4-f63bb44ce66b</d2p1:FilterUid>
    <d2p1:Guids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>e414321f-258e-49fe-9161-daeb54d7b0e2</d3p1:guid>
      <d3p1:guid>35a1debe-baa6-4f1a-84b0-72be3d78a875</d3p1:guid>
    </d2p1:Guids>
    <d2p1:Items xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Items>
    <d2p1:SelectedIndex>1</d2p1:SelectedIndex>
    <d2p1:SelectedItem>sample string 3</d2p1:SelectedItem>
    <d2p1:Visible>true</d2p1:Visible>
  </SelectExtendLo>
  <ShowDoneCheckBox xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 4</d2p1:Caption>
    <d2p1:Checked>true</d2p1:Checked>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </ShowDoneCheckBox>
  <StgPrevNextButtonSelected>3</StgPrevNextButtonSelected>
  <TenonCountLabel>sample string 4</TenonCountLabel>
  <TenonNextButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </TenonNextButton>
  <TenonPreviousButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </TenonPreviousButton>
  <Theme>sample string 6</Theme>
  <WallCountLabel>sample string 5</WallCountLabel>
  <WallNextButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </WallNextButton>
  <WallPreviousButton xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Controls">
    <d2p1:Caption>sample string 3</d2p1:Caption>
    <d2p1:Enabled>true</d2p1:Enabled>
    <d2p1:Visible>true</d2p1:Visible>
  </WallPreviousButton>
  <ZoomParameter xmlns:d2p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto.Parameter">
    <d2p1:CanvasHeight>5</d2p1:CanvasHeight>
    <d2p1:CanvasWidth>6</d2p1:CanvasWidth>
    <d2p1:CtrlPress>true</d2p1:CtrlPress>
    <d2p1:EndX>3</d2p1:EndX>
    <d2p1:EndY>4</d2p1:EndY>
    <d2p1:StartX>1</d2p1:StartX>
    <d2p1:StartY>2</d2p1:StartY>
  </ZoomParameter>
  <isReverse>true</isReverse>
</StringSetoutViewModel>