docusign_esign.models.formula_tab
Docusign eSignature REST API
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 Docusign eSignature REST API 5 6 The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class FormulaTab(object): 23 """NOTE: This class is auto generated by the swagger code generator program. 24 25 Do not edit the class manually. 26 """ 27 28 """ 29 Attributes: 30 swagger_types (dict): The key is attribute name 31 and the value is attribute type. 32 attribute_map (dict): The key is attribute name 33 and the value is json key in definition. 34 """ 35 swagger_types = { 36 'agreement_attribute': 'str', 37 'agreement_attribute_locked': 'str', 38 'anchor_allow_white_space_in_characters': 'str', 39 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 40 'anchor_case_sensitive': 'str', 41 'anchor_case_sensitive_metadata': 'PropertyMetadata', 42 'anchor_horizontal_alignment': 'str', 43 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 44 'anchor_ignore_if_not_present': 'str', 45 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 46 'anchor_match_whole_word': 'str', 47 'anchor_match_whole_word_metadata': 'PropertyMetadata', 48 'anchor_string': 'str', 49 'anchor_string_metadata': 'PropertyMetadata', 50 'anchor_tab_processor_version': 'str', 51 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 52 'anchor_units': 'str', 53 'anchor_units_metadata': 'PropertyMetadata', 54 'anchor_x_offset': 'str', 55 'anchor_x_offset_metadata': 'PropertyMetadata', 56 'anchor_y_offset': 'str', 57 'anchor_y_offset_metadata': 'PropertyMetadata', 58 'bold': 'str', 59 'bold_metadata': 'PropertyMetadata', 60 'caption': 'str', 61 'caption_metadata': 'PropertyMetadata', 62 'conceal_value_on_document': 'str', 63 'conceal_value_on_document_metadata': 'PropertyMetadata', 64 'conditional_parent_label': 'str', 65 'conditional_parent_label_metadata': 'PropertyMetadata', 66 'conditional_parent_value': 'str', 67 'conditional_parent_value_metadata': 'PropertyMetadata', 68 'connected_object_details': 'ConnectedObjectDetails', 69 'custom_tab_id': 'str', 70 'custom_tab_id_metadata': 'PropertyMetadata', 71 'disable_auto_size': 'str', 72 'disable_auto_size_metadata': 'PropertyMetadata', 73 'document_id': 'str', 74 'document_id_metadata': 'PropertyMetadata', 75 'error_details': 'ErrorDetails', 76 'extension_data': 'ExtensionData', 77 'font': 'str', 78 'font_color': 'str', 79 'font_color_metadata': 'PropertyMetadata', 80 'font_metadata': 'PropertyMetadata', 81 'font_size': 'str', 82 'font_size_metadata': 'PropertyMetadata', 83 'form_order': 'str', 84 'form_order_metadata': 'PropertyMetadata', 85 'form_page_label': 'str', 86 'form_page_label_metadata': 'PropertyMetadata', 87 'form_page_number': 'str', 88 'form_page_number_metadata': 'PropertyMetadata', 89 'formula': 'str', 90 'formula_metadata': 'PropertyMetadata', 91 'height': 'str', 92 'height_metadata': 'PropertyMetadata', 93 'hidden': 'str', 94 'hidden_metadata': 'PropertyMetadata', 95 'is_payment_amount': 'str', 96 'is_payment_amount_metadata': 'PropertyMetadata', 97 'italic': 'str', 98 'italic_metadata': 'PropertyMetadata', 99 'locale_policy': 'LocalePolicyTab', 100 'locked': 'str', 101 'locked_metadata': 'PropertyMetadata', 102 'max_length': 'str', 103 'max_length_metadata': 'PropertyMetadata', 104 'merge_field': 'MergeField', 105 'merge_field_xml': 'str', 106 'name': 'str', 107 'name_metadata': 'PropertyMetadata', 108 'original_value': 'str', 109 'original_value_metadata': 'PropertyMetadata', 110 'page_number': 'str', 111 'page_number_metadata': 'PropertyMetadata', 112 'payment_details': 'PaymentDetails', 113 'recipient_id': 'str', 114 'recipient_id_guid': 'str', 115 'recipient_id_guid_metadata': 'PropertyMetadata', 116 'recipient_id_metadata': 'PropertyMetadata', 117 'require_all': 'str', 118 'require_all_metadata': 'PropertyMetadata', 119 'required': 'str', 120 'required_metadata': 'PropertyMetadata', 121 'require_initial_on_shared_change': 'str', 122 'require_initial_on_shared_change_metadata': 'PropertyMetadata', 123 'round_decimal_places': 'str', 124 'round_decimal_places_metadata': 'PropertyMetadata', 125 'sender_required': 'str', 126 'sender_required_metadata': 'PropertyMetadata', 127 'shared': 'str', 128 'shared_metadata': 'PropertyMetadata', 129 'share_to_recipients': 'str', 130 'share_to_recipients_metadata': 'PropertyMetadata', 131 'smart_contract_information': 'SmartContractInformation', 132 'source': 'str', 133 'status': 'str', 134 'status_metadata': 'PropertyMetadata', 135 'tab_fully_qualified_path': 'str', 136 'tab_group_labels': 'list[str]', 137 'tab_group_labels_metadata': 'PropertyMetadata', 138 'tab_id': 'str', 139 'tab_id_metadata': 'PropertyMetadata', 140 'tab_label': 'str', 141 'tab_label_metadata': 'PropertyMetadata', 142 'tab_order': 'str', 143 'tab_order_metadata': 'PropertyMetadata', 144 'tab_type': 'str', 145 'tab_type_metadata': 'PropertyMetadata', 146 'template_locked': 'str', 147 'template_locked_metadata': 'PropertyMetadata', 148 'template_required': 'str', 149 'template_required_metadata': 'PropertyMetadata', 150 'tooltip': 'str', 151 'tool_tip_metadata': 'PropertyMetadata', 152 'underline': 'str', 153 'underline_metadata': 'PropertyMetadata', 154 'validation_message': 'str', 155 'validation_message_metadata': 'PropertyMetadata', 156 'validation_pattern': 'str', 157 'validation_pattern_metadata': 'PropertyMetadata', 158 'value': 'str', 159 'value_metadata': 'PropertyMetadata', 160 'warning_details': 'ErrorDetails', 161 'width': 'str', 162 'width_metadata': 'PropertyMetadata', 163 'x_position': 'str', 164 'x_position_metadata': 'PropertyMetadata', 165 'y_position': 'str', 166 'y_position_metadata': 'PropertyMetadata' 167 } 168 169 attribute_map = { 170 'agreement_attribute': 'agreementAttribute', 171 'agreement_attribute_locked': 'agreementAttributeLocked', 172 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 173 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 174 'anchor_case_sensitive': 'anchorCaseSensitive', 175 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 176 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 177 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 178 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 179 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 180 'anchor_match_whole_word': 'anchorMatchWholeWord', 181 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 182 'anchor_string': 'anchorString', 183 'anchor_string_metadata': 'anchorStringMetadata', 184 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 185 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 186 'anchor_units': 'anchorUnits', 187 'anchor_units_metadata': 'anchorUnitsMetadata', 188 'anchor_x_offset': 'anchorXOffset', 189 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 190 'anchor_y_offset': 'anchorYOffset', 191 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 192 'bold': 'bold', 193 'bold_metadata': 'boldMetadata', 194 'caption': 'caption', 195 'caption_metadata': 'captionMetadata', 196 'conceal_value_on_document': 'concealValueOnDocument', 197 'conceal_value_on_document_metadata': 'concealValueOnDocumentMetadata', 198 'conditional_parent_label': 'conditionalParentLabel', 199 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 200 'conditional_parent_value': 'conditionalParentValue', 201 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 202 'connected_object_details': 'connectedObjectDetails', 203 'custom_tab_id': 'customTabId', 204 'custom_tab_id_metadata': 'customTabIdMetadata', 205 'disable_auto_size': 'disableAutoSize', 206 'disable_auto_size_metadata': 'disableAutoSizeMetadata', 207 'document_id': 'documentId', 208 'document_id_metadata': 'documentIdMetadata', 209 'error_details': 'errorDetails', 210 'extension_data': 'extensionData', 211 'font': 'font', 212 'font_color': 'fontColor', 213 'font_color_metadata': 'fontColorMetadata', 214 'font_metadata': 'fontMetadata', 215 'font_size': 'fontSize', 216 'font_size_metadata': 'fontSizeMetadata', 217 'form_order': 'formOrder', 218 'form_order_metadata': 'formOrderMetadata', 219 'form_page_label': 'formPageLabel', 220 'form_page_label_metadata': 'formPageLabelMetadata', 221 'form_page_number': 'formPageNumber', 222 'form_page_number_metadata': 'formPageNumberMetadata', 223 'formula': 'formula', 224 'formula_metadata': 'formulaMetadata', 225 'height': 'height', 226 'height_metadata': 'heightMetadata', 227 'hidden': 'hidden', 228 'hidden_metadata': 'hiddenMetadata', 229 'is_payment_amount': 'isPaymentAmount', 230 'is_payment_amount_metadata': 'isPaymentAmountMetadata', 231 'italic': 'italic', 232 'italic_metadata': 'italicMetadata', 233 'locale_policy': 'localePolicy', 234 'locked': 'locked', 235 'locked_metadata': 'lockedMetadata', 236 'max_length': 'maxLength', 237 'max_length_metadata': 'maxLengthMetadata', 238 'merge_field': 'mergeField', 239 'merge_field_xml': 'mergeFieldXml', 240 'name': 'name', 241 'name_metadata': 'nameMetadata', 242 'original_value': 'originalValue', 243 'original_value_metadata': 'originalValueMetadata', 244 'page_number': 'pageNumber', 245 'page_number_metadata': 'pageNumberMetadata', 246 'payment_details': 'paymentDetails', 247 'recipient_id': 'recipientId', 248 'recipient_id_guid': 'recipientIdGuid', 249 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 250 'recipient_id_metadata': 'recipientIdMetadata', 251 'require_all': 'requireAll', 252 'require_all_metadata': 'requireAllMetadata', 253 'required': 'required', 254 'required_metadata': 'requiredMetadata', 255 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 256 'require_initial_on_shared_change_metadata': 'requireInitialOnSharedChangeMetadata', 257 'round_decimal_places': 'roundDecimalPlaces', 258 'round_decimal_places_metadata': 'roundDecimalPlacesMetadata', 259 'sender_required': 'senderRequired', 260 'sender_required_metadata': 'senderRequiredMetadata', 261 'shared': 'shared', 262 'shared_metadata': 'sharedMetadata', 263 'share_to_recipients': 'shareToRecipients', 264 'share_to_recipients_metadata': 'shareToRecipientsMetadata', 265 'smart_contract_information': 'smartContractInformation', 266 'source': 'source', 267 'status': 'status', 268 'status_metadata': 'statusMetadata', 269 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 270 'tab_group_labels': 'tabGroupLabels', 271 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 272 'tab_id': 'tabId', 273 'tab_id_metadata': 'tabIdMetadata', 274 'tab_label': 'tabLabel', 275 'tab_label_metadata': 'tabLabelMetadata', 276 'tab_order': 'tabOrder', 277 'tab_order_metadata': 'tabOrderMetadata', 278 'tab_type': 'tabType', 279 'tab_type_metadata': 'tabTypeMetadata', 280 'template_locked': 'templateLocked', 281 'template_locked_metadata': 'templateLockedMetadata', 282 'template_required': 'templateRequired', 283 'template_required_metadata': 'templateRequiredMetadata', 284 'tooltip': 'tooltip', 285 'tool_tip_metadata': 'toolTipMetadata', 286 'underline': 'underline', 287 'underline_metadata': 'underlineMetadata', 288 'validation_message': 'validationMessage', 289 'validation_message_metadata': 'validationMessageMetadata', 290 'validation_pattern': 'validationPattern', 291 'validation_pattern_metadata': 'validationPatternMetadata', 292 'value': 'value', 293 'value_metadata': 'valueMetadata', 294 'warning_details': 'warningDetails', 295 'width': 'width', 296 'width_metadata': 'widthMetadata', 297 'x_position': 'xPosition', 298 'x_position_metadata': 'xPositionMetadata', 299 'y_position': 'yPosition', 300 'y_position_metadata': 'yPositionMetadata' 301 } 302 303 def __init__(self, _configuration=None, **kwargs): # noqa: E501 304 """FormulaTab - a model defined in Swagger""" # noqa: E501 305 if _configuration is None: 306 _configuration = Configuration() 307 self._configuration = _configuration 308 309 self._agreement_attribute = None 310 self._agreement_attribute_locked = None 311 self._anchor_allow_white_space_in_characters = None 312 self._anchor_allow_white_space_in_characters_metadata = None 313 self._anchor_case_sensitive = None 314 self._anchor_case_sensitive_metadata = None 315 self._anchor_horizontal_alignment = None 316 self._anchor_horizontal_alignment_metadata = None 317 self._anchor_ignore_if_not_present = None 318 self._anchor_ignore_if_not_present_metadata = None 319 self._anchor_match_whole_word = None 320 self._anchor_match_whole_word_metadata = None 321 self._anchor_string = None 322 self._anchor_string_metadata = None 323 self._anchor_tab_processor_version = None 324 self._anchor_tab_processor_version_metadata = None 325 self._anchor_units = None 326 self._anchor_units_metadata = None 327 self._anchor_x_offset = None 328 self._anchor_x_offset_metadata = None 329 self._anchor_y_offset = None 330 self._anchor_y_offset_metadata = None 331 self._bold = None 332 self._bold_metadata = None 333 self._caption = None 334 self._caption_metadata = None 335 self._conceal_value_on_document = None 336 self._conceal_value_on_document_metadata = None 337 self._conditional_parent_label = None 338 self._conditional_parent_label_metadata = None 339 self._conditional_parent_value = None 340 self._conditional_parent_value_metadata = None 341 self._connected_object_details = None 342 self._custom_tab_id = None 343 self._custom_tab_id_metadata = None 344 self._disable_auto_size = None 345 self._disable_auto_size_metadata = None 346 self._document_id = None 347 self._document_id_metadata = None 348 self._error_details = None 349 self._extension_data = None 350 self._font = None 351 self._font_color = None 352 self._font_color_metadata = None 353 self._font_metadata = None 354 self._font_size = None 355 self._font_size_metadata = None 356 self._form_order = None 357 self._form_order_metadata = None 358 self._form_page_label = None 359 self._form_page_label_metadata = None 360 self._form_page_number = None 361 self._form_page_number_metadata = None 362 self._formula = None 363 self._formula_metadata = None 364 self._height = None 365 self._height_metadata = None 366 self._hidden = None 367 self._hidden_metadata = None 368 self._is_payment_amount = None 369 self._is_payment_amount_metadata = None 370 self._italic = None 371 self._italic_metadata = None 372 self._locale_policy = None 373 self._locked = None 374 self._locked_metadata = None 375 self._max_length = None 376 self._max_length_metadata = None 377 self._merge_field = None 378 self._merge_field_xml = None 379 self._name = None 380 self._name_metadata = None 381 self._original_value = None 382 self._original_value_metadata = None 383 self._page_number = None 384 self._page_number_metadata = None 385 self._payment_details = None 386 self._recipient_id = None 387 self._recipient_id_guid = None 388 self._recipient_id_guid_metadata = None 389 self._recipient_id_metadata = None 390 self._require_all = None 391 self._require_all_metadata = None 392 self._required = None 393 self._required_metadata = None 394 self._require_initial_on_shared_change = None 395 self._require_initial_on_shared_change_metadata = None 396 self._round_decimal_places = None 397 self._round_decimal_places_metadata = None 398 self._sender_required = None 399 self._sender_required_metadata = None 400 self._shared = None 401 self._shared_metadata = None 402 self._share_to_recipients = None 403 self._share_to_recipients_metadata = None 404 self._smart_contract_information = None 405 self._source = None 406 self._status = None 407 self._status_metadata = None 408 self._tab_fully_qualified_path = None 409 self._tab_group_labels = None 410 self._tab_group_labels_metadata = None 411 self._tab_id = None 412 self._tab_id_metadata = None 413 self._tab_label = None 414 self._tab_label_metadata = None 415 self._tab_order = None 416 self._tab_order_metadata = None 417 self._tab_type = None 418 self._tab_type_metadata = None 419 self._template_locked = None 420 self._template_locked_metadata = None 421 self._template_required = None 422 self._template_required_metadata = None 423 self._tooltip = None 424 self._tool_tip_metadata = None 425 self._underline = None 426 self._underline_metadata = None 427 self._validation_message = None 428 self._validation_message_metadata = None 429 self._validation_pattern = None 430 self._validation_pattern_metadata = None 431 self._value = None 432 self._value_metadata = None 433 self._warning_details = None 434 self._width = None 435 self._width_metadata = None 436 self._x_position = None 437 self._x_position_metadata = None 438 self._y_position = None 439 self._y_position_metadata = None 440 self.discriminator = None 441 442 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 443 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 444 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 445 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 446 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 447 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 448 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 449 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 450 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 451 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 452 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 453 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 454 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 455 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 456 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 457 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 458 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 459 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 460 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 461 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 462 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 463 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 464 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 465 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 466 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 467 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 468 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 469 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 470 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 471 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 472 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 473 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 474 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 475 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 476 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 477 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 478 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 479 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 480 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 481 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 482 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 483 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 484 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 485 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 486 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 487 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 488 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 489 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 490 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 491 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 492 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 493 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 494 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 495 setattr(self, "_{}".format('formula'), kwargs.get('formula', None)) 496 setattr(self, "_{}".format('formula_metadata'), kwargs.get('formula_metadata', None)) 497 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 498 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 499 setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None)) 500 setattr(self, "_{}".format('hidden_metadata'), kwargs.get('hidden_metadata', None)) 501 setattr(self, "_{}".format('is_payment_amount'), kwargs.get('is_payment_amount', None)) 502 setattr(self, "_{}".format('is_payment_amount_metadata'), kwargs.get('is_payment_amount_metadata', None)) 503 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 504 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 505 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 506 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 507 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 508 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 509 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 510 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 511 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 512 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 513 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 514 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 515 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 516 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 517 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 518 setattr(self, "_{}".format('payment_details'), kwargs.get('payment_details', None)) 519 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 520 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 521 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 522 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 523 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 524 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 525 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 526 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 527 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 528 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 529 setattr(self, "_{}".format('round_decimal_places'), kwargs.get('round_decimal_places', None)) 530 setattr(self, "_{}".format('round_decimal_places_metadata'), kwargs.get('round_decimal_places_metadata', None)) 531 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 532 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 533 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 534 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 535 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 536 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 537 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 538 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 539 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 540 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 541 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 542 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 543 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 544 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 545 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 546 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 547 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 548 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 549 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 550 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 551 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 552 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 553 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 554 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 555 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 556 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 557 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 558 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 559 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 560 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 561 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 562 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 563 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 564 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 565 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 566 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 567 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 568 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 569 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 570 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 571 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 572 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None)) 573 574 @property 575 def agreement_attribute(self): 576 """Gets the agreement_attribute of this FormulaTab. # noqa: E501 577 578 # noqa: E501 579 580 :return: The agreement_attribute of this FormulaTab. # noqa: E501 581 :rtype: str 582 """ 583 return self._agreement_attribute 584 585 @agreement_attribute.setter 586 def agreement_attribute(self, agreement_attribute): 587 """Sets the agreement_attribute of this FormulaTab. 588 589 # noqa: E501 590 591 :param agreement_attribute: The agreement_attribute of this FormulaTab. # noqa: E501 592 :type: str 593 """ 594 595 self._agreement_attribute = agreement_attribute 596 597 @property 598 def agreement_attribute_locked(self): 599 """Gets the agreement_attribute_locked of this FormulaTab. # noqa: E501 600 601 # noqa: E501 602 603 :return: The agreement_attribute_locked of this FormulaTab. # noqa: E501 604 :rtype: str 605 """ 606 return self._agreement_attribute_locked 607 608 @agreement_attribute_locked.setter 609 def agreement_attribute_locked(self, agreement_attribute_locked): 610 """Sets the agreement_attribute_locked of this FormulaTab. 611 612 # noqa: E501 613 614 :param agreement_attribute_locked: The agreement_attribute_locked of this FormulaTab. # noqa: E501 615 :type: str 616 """ 617 618 self._agreement_attribute_locked = agreement_attribute_locked 619 620 @property 621 def anchor_allow_white_space_in_characters(self): 622 """Gets the anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 623 624 # noqa: E501 625 626 :return: The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 627 :rtype: str 628 """ 629 return self._anchor_allow_white_space_in_characters 630 631 @anchor_allow_white_space_in_characters.setter 632 def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): 633 """Sets the anchor_allow_white_space_in_characters of this FormulaTab. 634 635 # noqa: E501 636 637 :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 638 :type: str 639 """ 640 641 self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters 642 643 @property 644 def anchor_allow_white_space_in_characters_metadata(self): 645 """Gets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 646 647 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 648 649 :return: The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 650 :rtype: PropertyMetadata 651 """ 652 return self._anchor_allow_white_space_in_characters_metadata 653 654 @anchor_allow_white_space_in_characters_metadata.setter 655 def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): 656 """Sets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. 657 658 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 659 660 :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 661 :type: PropertyMetadata 662 """ 663 664 self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata 665 666 @property 667 def anchor_case_sensitive(self): 668 """Gets the anchor_case_sensitive of this FormulaTab. # noqa: E501 669 670 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 671 672 :return: The anchor_case_sensitive of this FormulaTab. # noqa: E501 673 :rtype: str 674 """ 675 return self._anchor_case_sensitive 676 677 @anchor_case_sensitive.setter 678 def anchor_case_sensitive(self, anchor_case_sensitive): 679 """Sets the anchor_case_sensitive of this FormulaTab. 680 681 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 682 683 :param anchor_case_sensitive: The anchor_case_sensitive of this FormulaTab. # noqa: E501 684 :type: str 685 """ 686 687 self._anchor_case_sensitive = anchor_case_sensitive 688 689 @property 690 def anchor_case_sensitive_metadata(self): 691 """Gets the anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 692 693 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 694 695 :return: The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 696 :rtype: PropertyMetadata 697 """ 698 return self._anchor_case_sensitive_metadata 699 700 @anchor_case_sensitive_metadata.setter 701 def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): 702 """Sets the anchor_case_sensitive_metadata of this FormulaTab. 703 704 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 705 706 :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 707 :type: PropertyMetadata 708 """ 709 710 self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata 711 712 @property 713 def anchor_horizontal_alignment(self): 714 """Gets the anchor_horizontal_alignment of this FormulaTab. # noqa: E501 715 716 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 717 718 :return: The anchor_horizontal_alignment of this FormulaTab. # noqa: E501 719 :rtype: str 720 """ 721 return self._anchor_horizontal_alignment 722 723 @anchor_horizontal_alignment.setter 724 def anchor_horizontal_alignment(self, anchor_horizontal_alignment): 725 """Sets the anchor_horizontal_alignment of this FormulaTab. 726 727 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 728 729 :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this FormulaTab. # noqa: E501 730 :type: str 731 """ 732 733 self._anchor_horizontal_alignment = anchor_horizontal_alignment 734 735 @property 736 def anchor_horizontal_alignment_metadata(self): 737 """Gets the anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 738 739 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 740 741 :return: The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 742 :rtype: PropertyMetadata 743 """ 744 return self._anchor_horizontal_alignment_metadata 745 746 @anchor_horizontal_alignment_metadata.setter 747 def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): 748 """Sets the anchor_horizontal_alignment_metadata of this FormulaTab. 749 750 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 751 752 :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 753 :type: PropertyMetadata 754 """ 755 756 self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata 757 758 @property 759 def anchor_ignore_if_not_present(self): 760 """Gets the anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 761 762 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 763 764 :return: The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 765 :rtype: str 766 """ 767 return self._anchor_ignore_if_not_present 768 769 @anchor_ignore_if_not_present.setter 770 def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): 771 """Sets the anchor_ignore_if_not_present of this FormulaTab. 772 773 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 774 775 :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 776 :type: str 777 """ 778 779 self._anchor_ignore_if_not_present = anchor_ignore_if_not_present 780 781 @property 782 def anchor_ignore_if_not_present_metadata(self): 783 """Gets the anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 784 785 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 786 787 :return: The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 788 :rtype: PropertyMetadata 789 """ 790 return self._anchor_ignore_if_not_present_metadata 791 792 @anchor_ignore_if_not_present_metadata.setter 793 def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): 794 """Sets the anchor_ignore_if_not_present_metadata of this FormulaTab. 795 796 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 797 798 :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 799 :type: PropertyMetadata 800 """ 801 802 self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata 803 804 @property 805 def anchor_match_whole_word(self): 806 """Gets the anchor_match_whole_word of this FormulaTab. # noqa: E501 807 808 When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. # noqa: E501 809 810 :return: The anchor_match_whole_word of this FormulaTab. # noqa: E501 811 :rtype: str 812 """ 813 return self._anchor_match_whole_word 814 815 @anchor_match_whole_word.setter 816 def anchor_match_whole_word(self, anchor_match_whole_word): 817 """Sets the anchor_match_whole_word of this FormulaTab. 818 819 When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. # noqa: E501 820 821 :param anchor_match_whole_word: The anchor_match_whole_word of this FormulaTab. # noqa: E501 822 :type: str 823 """ 824 825 self._anchor_match_whole_word = anchor_match_whole_word 826 827 @property 828 def anchor_match_whole_word_metadata(self): 829 """Gets the anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 830 831 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 832 833 :return: The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 834 :rtype: PropertyMetadata 835 """ 836 return self._anchor_match_whole_word_metadata 837 838 @anchor_match_whole_word_metadata.setter 839 def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): 840 """Sets the anchor_match_whole_word_metadata of this FormulaTab. 841 842 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 843 844 :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 845 :type: PropertyMetadata 846 """ 847 848 self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata 849 850 @property 851 def anchor_string(self): 852 """Gets the anchor_string of this FormulaTab. # noqa: E501 853 854 Anchor text information for a radio button. # noqa: E501 855 856 :return: The anchor_string of this FormulaTab. # noqa: E501 857 :rtype: str 858 """ 859 return self._anchor_string 860 861 @anchor_string.setter 862 def anchor_string(self, anchor_string): 863 """Sets the anchor_string of this FormulaTab. 864 865 Anchor text information for a radio button. # noqa: E501 866 867 :param anchor_string: The anchor_string of this FormulaTab. # noqa: E501 868 :type: str 869 """ 870 871 self._anchor_string = anchor_string 872 873 @property 874 def anchor_string_metadata(self): 875 """Gets the anchor_string_metadata of this FormulaTab. # noqa: E501 876 877 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 878 879 :return: The anchor_string_metadata of this FormulaTab. # noqa: E501 880 :rtype: PropertyMetadata 881 """ 882 return self._anchor_string_metadata 883 884 @anchor_string_metadata.setter 885 def anchor_string_metadata(self, anchor_string_metadata): 886 """Sets the anchor_string_metadata of this FormulaTab. 887 888 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 889 890 :param anchor_string_metadata: The anchor_string_metadata of this FormulaTab. # noqa: E501 891 :type: PropertyMetadata 892 """ 893 894 self._anchor_string_metadata = anchor_string_metadata 895 896 @property 897 def anchor_tab_processor_version(self): 898 """Gets the anchor_tab_processor_version of this FormulaTab. # noqa: E501 899 900 # noqa: E501 901 902 :return: The anchor_tab_processor_version of this FormulaTab. # noqa: E501 903 :rtype: str 904 """ 905 return self._anchor_tab_processor_version 906 907 @anchor_tab_processor_version.setter 908 def anchor_tab_processor_version(self, anchor_tab_processor_version): 909 """Sets the anchor_tab_processor_version of this FormulaTab. 910 911 # noqa: E501 912 913 :param anchor_tab_processor_version: The anchor_tab_processor_version of this FormulaTab. # noqa: E501 914 :type: str 915 """ 916 917 self._anchor_tab_processor_version = anchor_tab_processor_version 918 919 @property 920 def anchor_tab_processor_version_metadata(self): 921 """Gets the anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 922 923 Reserved for DocuSign. # noqa: E501 924 925 :return: The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 926 :rtype: PropertyMetadata 927 """ 928 return self._anchor_tab_processor_version_metadata 929 930 @anchor_tab_processor_version_metadata.setter 931 def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): 932 """Sets the anchor_tab_processor_version_metadata of this FormulaTab. 933 934 Reserved for DocuSign. # noqa: E501 935 936 :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 937 :type: PropertyMetadata 938 """ 939 940 self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata 941 942 @property 943 def anchor_units(self): 944 """Gets the anchor_units of this FormulaTab. # noqa: E501 945 946 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 947 948 :return: The anchor_units of this FormulaTab. # noqa: E501 949 :rtype: str 950 """ 951 return self._anchor_units 952 953 @anchor_units.setter 954 def anchor_units(self, anchor_units): 955 """Sets the anchor_units of this FormulaTab. 956 957 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 958 959 :param anchor_units: The anchor_units of this FormulaTab. # noqa: E501 960 :type: str 961 """ 962 963 self._anchor_units = anchor_units 964 965 @property 966 def anchor_units_metadata(self): 967 """Gets the anchor_units_metadata of this FormulaTab. # noqa: E501 968 969 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 970 971 :return: The anchor_units_metadata of this FormulaTab. # noqa: E501 972 :rtype: PropertyMetadata 973 """ 974 return self._anchor_units_metadata 975 976 @anchor_units_metadata.setter 977 def anchor_units_metadata(self, anchor_units_metadata): 978 """Sets the anchor_units_metadata of this FormulaTab. 979 980 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 981 982 :param anchor_units_metadata: The anchor_units_metadata of this FormulaTab. # noqa: E501 983 :type: PropertyMetadata 984 """ 985 986 self._anchor_units_metadata = anchor_units_metadata 987 988 @property 989 def anchor_x_offset(self): 990 """Gets the anchor_x_offset of this FormulaTab. # noqa: E501 991 992 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 993 994 :return: The anchor_x_offset of this FormulaTab. # noqa: E501 995 :rtype: str 996 """ 997 return self._anchor_x_offset 998 999 @anchor_x_offset.setter 1000 def anchor_x_offset(self, anchor_x_offset): 1001 """Sets the anchor_x_offset of this FormulaTab. 1002 1003 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1004 1005 :param anchor_x_offset: The anchor_x_offset of this FormulaTab. # noqa: E501 1006 :type: str 1007 """ 1008 1009 self._anchor_x_offset = anchor_x_offset 1010 1011 @property 1012 def anchor_x_offset_metadata(self): 1013 """Gets the anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1014 1015 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1016 1017 :return: The anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1018 :rtype: PropertyMetadata 1019 """ 1020 return self._anchor_x_offset_metadata 1021 1022 @anchor_x_offset_metadata.setter 1023 def anchor_x_offset_metadata(self, anchor_x_offset_metadata): 1024 """Sets the anchor_x_offset_metadata of this FormulaTab. 1025 1026 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1027 1028 :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1029 :type: PropertyMetadata 1030 """ 1031 1032 self._anchor_x_offset_metadata = anchor_x_offset_metadata 1033 1034 @property 1035 def anchor_y_offset(self): 1036 """Gets the anchor_y_offset of this FormulaTab. # noqa: E501 1037 1038 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1039 1040 :return: The anchor_y_offset of this FormulaTab. # noqa: E501 1041 :rtype: str 1042 """ 1043 return self._anchor_y_offset 1044 1045 @anchor_y_offset.setter 1046 def anchor_y_offset(self, anchor_y_offset): 1047 """Sets the anchor_y_offset of this FormulaTab. 1048 1049 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1050 1051 :param anchor_y_offset: The anchor_y_offset of this FormulaTab. # noqa: E501 1052 :type: str 1053 """ 1054 1055 self._anchor_y_offset = anchor_y_offset 1056 1057 @property 1058 def anchor_y_offset_metadata(self): 1059 """Gets the anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1060 1061 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1062 1063 :return: The anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1064 :rtype: PropertyMetadata 1065 """ 1066 return self._anchor_y_offset_metadata 1067 1068 @anchor_y_offset_metadata.setter 1069 def anchor_y_offset_metadata(self, anchor_y_offset_metadata): 1070 """Sets the anchor_y_offset_metadata of this FormulaTab. 1071 1072 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1073 1074 :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1075 :type: PropertyMetadata 1076 """ 1077 1078 self._anchor_y_offset_metadata = anchor_y_offset_metadata 1079 1080 @property 1081 def bold(self): 1082 """Gets the bold of this FormulaTab. # noqa: E501 1083 1084 When set to **true**, the information in the tab is bold. # noqa: E501 1085 1086 :return: The bold of this FormulaTab. # noqa: E501 1087 :rtype: str 1088 """ 1089 return self._bold 1090 1091 @bold.setter 1092 def bold(self, bold): 1093 """Sets the bold of this FormulaTab. 1094 1095 When set to **true**, the information in the tab is bold. # noqa: E501 1096 1097 :param bold: The bold of this FormulaTab. # noqa: E501 1098 :type: str 1099 """ 1100 1101 self._bold = bold 1102 1103 @property 1104 def bold_metadata(self): 1105 """Gets the bold_metadata of this FormulaTab. # noqa: E501 1106 1107 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1108 1109 :return: The bold_metadata of this FormulaTab. # noqa: E501 1110 :rtype: PropertyMetadata 1111 """ 1112 return self._bold_metadata 1113 1114 @bold_metadata.setter 1115 def bold_metadata(self, bold_metadata): 1116 """Sets the bold_metadata of this FormulaTab. 1117 1118 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1119 1120 :param bold_metadata: The bold_metadata of this FormulaTab. # noqa: E501 1121 :type: PropertyMetadata 1122 """ 1123 1124 self._bold_metadata = bold_metadata 1125 1126 @property 1127 def caption(self): 1128 """Gets the caption of this FormulaTab. # noqa: E501 1129 1130 # noqa: E501 1131 1132 :return: The caption of this FormulaTab. # noqa: E501 1133 :rtype: str 1134 """ 1135 return self._caption 1136 1137 @caption.setter 1138 def caption(self, caption): 1139 """Sets the caption of this FormulaTab. 1140 1141 # noqa: E501 1142 1143 :param caption: The caption of this FormulaTab. # noqa: E501 1144 :type: str 1145 """ 1146 1147 self._caption = caption 1148 1149 @property 1150 def caption_metadata(self): 1151 """Gets the caption_metadata of this FormulaTab. # noqa: E501 1152 1153 # noqa: E501 1154 1155 :return: The caption_metadata of this FormulaTab. # noqa: E501 1156 :rtype: PropertyMetadata 1157 """ 1158 return self._caption_metadata 1159 1160 @caption_metadata.setter 1161 def caption_metadata(self, caption_metadata): 1162 """Sets the caption_metadata of this FormulaTab. 1163 1164 # noqa: E501 1165 1166 :param caption_metadata: The caption_metadata of this FormulaTab. # noqa: E501 1167 :type: PropertyMetadata 1168 """ 1169 1170 self._caption_metadata = caption_metadata 1171 1172 @property 1173 def conceal_value_on_document(self): 1174 """Gets the conceal_value_on_document of this FormulaTab. # noqa: E501 1175 1176 When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501 1177 1178 :return: The conceal_value_on_document of this FormulaTab. # noqa: E501 1179 :rtype: str 1180 """ 1181 return self._conceal_value_on_document 1182 1183 @conceal_value_on_document.setter 1184 def conceal_value_on_document(self, conceal_value_on_document): 1185 """Sets the conceal_value_on_document of this FormulaTab. 1186 1187 When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501 1188 1189 :param conceal_value_on_document: The conceal_value_on_document of this FormulaTab. # noqa: E501 1190 :type: str 1191 """ 1192 1193 self._conceal_value_on_document = conceal_value_on_document 1194 1195 @property 1196 def conceal_value_on_document_metadata(self): 1197 """Gets the conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1198 1199 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1200 1201 :return: The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1202 :rtype: PropertyMetadata 1203 """ 1204 return self._conceal_value_on_document_metadata 1205 1206 @conceal_value_on_document_metadata.setter 1207 def conceal_value_on_document_metadata(self, conceal_value_on_document_metadata): 1208 """Sets the conceal_value_on_document_metadata of this FormulaTab. 1209 1210 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1211 1212 :param conceal_value_on_document_metadata: The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1213 :type: PropertyMetadata 1214 """ 1215 1216 self._conceal_value_on_document_metadata = conceal_value_on_document_metadata 1217 1218 @property 1219 def conditional_parent_label(self): 1220 """Gets the conditional_parent_label of this FormulaTab. # noqa: E501 1221 1222 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1223 1224 :return: The conditional_parent_label of this FormulaTab. # noqa: E501 1225 :rtype: str 1226 """ 1227 return self._conditional_parent_label 1228 1229 @conditional_parent_label.setter 1230 def conditional_parent_label(self, conditional_parent_label): 1231 """Sets the conditional_parent_label of this FormulaTab. 1232 1233 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1234 1235 :param conditional_parent_label: The conditional_parent_label of this FormulaTab. # noqa: E501 1236 :type: str 1237 """ 1238 1239 self._conditional_parent_label = conditional_parent_label 1240 1241 @property 1242 def conditional_parent_label_metadata(self): 1243 """Gets the conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1244 1245 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1246 1247 :return: The conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1248 :rtype: PropertyMetadata 1249 """ 1250 return self._conditional_parent_label_metadata 1251 1252 @conditional_parent_label_metadata.setter 1253 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 1254 """Sets the conditional_parent_label_metadata of this FormulaTab. 1255 1256 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1257 1258 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1259 :type: PropertyMetadata 1260 """ 1261 1262 self._conditional_parent_label_metadata = conditional_parent_label_metadata 1263 1264 @property 1265 def conditional_parent_value(self): 1266 """Gets the conditional_parent_value of this FormulaTab. # noqa: E501 1267 1268 For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 1269 1270 :return: The conditional_parent_value of this FormulaTab. # noqa: E501 1271 :rtype: str 1272 """ 1273 return self._conditional_parent_value 1274 1275 @conditional_parent_value.setter 1276 def conditional_parent_value(self, conditional_parent_value): 1277 """Sets the conditional_parent_value of this FormulaTab. 1278 1279 For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 1280 1281 :param conditional_parent_value: The conditional_parent_value of this FormulaTab. # noqa: E501 1282 :type: str 1283 """ 1284 1285 self._conditional_parent_value = conditional_parent_value 1286 1287 @property 1288 def conditional_parent_value_metadata(self): 1289 """Gets the conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1290 1291 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1292 1293 :return: The conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1294 :rtype: PropertyMetadata 1295 """ 1296 return self._conditional_parent_value_metadata 1297 1298 @conditional_parent_value_metadata.setter 1299 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 1300 """Sets the conditional_parent_value_metadata of this FormulaTab. 1301 1302 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1303 1304 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1305 :type: PropertyMetadata 1306 """ 1307 1308 self._conditional_parent_value_metadata = conditional_parent_value_metadata 1309 1310 @property 1311 def connected_object_details(self): 1312 """Gets the connected_object_details of this FormulaTab. # noqa: E501 1313 1314 # noqa: E501 1315 1316 :return: The connected_object_details of this FormulaTab. # noqa: E501 1317 :rtype: ConnectedObjectDetails 1318 """ 1319 return self._connected_object_details 1320 1321 @connected_object_details.setter 1322 def connected_object_details(self, connected_object_details): 1323 """Sets the connected_object_details of this FormulaTab. 1324 1325 # noqa: E501 1326 1327 :param connected_object_details: The connected_object_details of this FormulaTab. # noqa: E501 1328 :type: ConnectedObjectDetails 1329 """ 1330 1331 self._connected_object_details = connected_object_details 1332 1333 @property 1334 def custom_tab_id(self): 1335 """Gets the custom_tab_id of this FormulaTab. # noqa: E501 1336 1337 The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501 1338 1339 :return: The custom_tab_id of this FormulaTab. # noqa: E501 1340 :rtype: str 1341 """ 1342 return self._custom_tab_id 1343 1344 @custom_tab_id.setter 1345 def custom_tab_id(self, custom_tab_id): 1346 """Sets the custom_tab_id of this FormulaTab. 1347 1348 The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501 1349 1350 :param custom_tab_id: The custom_tab_id of this FormulaTab. # noqa: E501 1351 :type: str 1352 """ 1353 1354 self._custom_tab_id = custom_tab_id 1355 1356 @property 1357 def custom_tab_id_metadata(self): 1358 """Gets the custom_tab_id_metadata of this FormulaTab. # noqa: E501 1359 1360 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1361 1362 :return: The custom_tab_id_metadata of this FormulaTab. # noqa: E501 1363 :rtype: PropertyMetadata 1364 """ 1365 return self._custom_tab_id_metadata 1366 1367 @custom_tab_id_metadata.setter 1368 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1369 """Sets the custom_tab_id_metadata of this FormulaTab. 1370 1371 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1372 1373 :param custom_tab_id_metadata: The custom_tab_id_metadata of this FormulaTab. # noqa: E501 1374 :type: PropertyMetadata 1375 """ 1376 1377 self._custom_tab_id_metadata = custom_tab_id_metadata 1378 1379 @property 1380 def disable_auto_size(self): 1381 """Gets the disable_auto_size of this FormulaTab. # noqa: E501 1382 1383 When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501 1384 1385 :return: The disable_auto_size of this FormulaTab. # noqa: E501 1386 :rtype: str 1387 """ 1388 return self._disable_auto_size 1389 1390 @disable_auto_size.setter 1391 def disable_auto_size(self, disable_auto_size): 1392 """Sets the disable_auto_size of this FormulaTab. 1393 1394 When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501 1395 1396 :param disable_auto_size: The disable_auto_size of this FormulaTab. # noqa: E501 1397 :type: str 1398 """ 1399 1400 self._disable_auto_size = disable_auto_size 1401 1402 @property 1403 def disable_auto_size_metadata(self): 1404 """Gets the disable_auto_size_metadata of this FormulaTab. # noqa: E501 1405 1406 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1407 1408 :return: The disable_auto_size_metadata of this FormulaTab. # noqa: E501 1409 :rtype: PropertyMetadata 1410 """ 1411 return self._disable_auto_size_metadata 1412 1413 @disable_auto_size_metadata.setter 1414 def disable_auto_size_metadata(self, disable_auto_size_metadata): 1415 """Sets the disable_auto_size_metadata of this FormulaTab. 1416 1417 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1418 1419 :param disable_auto_size_metadata: The disable_auto_size_metadata of this FormulaTab. # noqa: E501 1420 :type: PropertyMetadata 1421 """ 1422 1423 self._disable_auto_size_metadata = disable_auto_size_metadata 1424 1425 @property 1426 def document_id(self): 1427 """Gets the document_id of this FormulaTab. # noqa: E501 1428 1429 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1430 1431 :return: The document_id of this FormulaTab. # noqa: E501 1432 :rtype: str 1433 """ 1434 return self._document_id 1435 1436 @document_id.setter 1437 def document_id(self, document_id): 1438 """Sets the document_id of this FormulaTab. 1439 1440 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1441 1442 :param document_id: The document_id of this FormulaTab. # noqa: E501 1443 :type: str 1444 """ 1445 1446 self._document_id = document_id 1447 1448 @property 1449 def document_id_metadata(self): 1450 """Gets the document_id_metadata of this FormulaTab. # noqa: E501 1451 1452 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1453 1454 :return: The document_id_metadata of this FormulaTab. # noqa: E501 1455 :rtype: PropertyMetadata 1456 """ 1457 return self._document_id_metadata 1458 1459 @document_id_metadata.setter 1460 def document_id_metadata(self, document_id_metadata): 1461 """Sets the document_id_metadata of this FormulaTab. 1462 1463 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1464 1465 :param document_id_metadata: The document_id_metadata of this FormulaTab. # noqa: E501 1466 :type: PropertyMetadata 1467 """ 1468 1469 self._document_id_metadata = document_id_metadata 1470 1471 @property 1472 def error_details(self): 1473 """Gets the error_details of this FormulaTab. # noqa: E501 1474 1475 Array or errors. # noqa: E501 1476 1477 :return: The error_details of this FormulaTab. # noqa: E501 1478 :rtype: ErrorDetails 1479 """ 1480 return self._error_details 1481 1482 @error_details.setter 1483 def error_details(self, error_details): 1484 """Sets the error_details of this FormulaTab. 1485 1486 Array or errors. # noqa: E501 1487 1488 :param error_details: The error_details of this FormulaTab. # noqa: E501 1489 :type: ErrorDetails 1490 """ 1491 1492 self._error_details = error_details 1493 1494 @property 1495 def extension_data(self): 1496 """Gets the extension_data of this FormulaTab. # noqa: E501 1497 1498 # noqa: E501 1499 1500 :return: The extension_data of this FormulaTab. # noqa: E501 1501 :rtype: ExtensionData 1502 """ 1503 return self._extension_data 1504 1505 @extension_data.setter 1506 def extension_data(self, extension_data): 1507 """Sets the extension_data of this FormulaTab. 1508 1509 # noqa: E501 1510 1511 :param extension_data: The extension_data of this FormulaTab. # noqa: E501 1512 :type: ExtensionData 1513 """ 1514 1515 self._extension_data = extension_data 1516 1517 @property 1518 def font(self): 1519 """Gets the font of this FormulaTab. # noqa: E501 1520 1521 The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. # noqa: E501 1522 1523 :return: The font of this FormulaTab. # noqa: E501 1524 :rtype: str 1525 """ 1526 return self._font 1527 1528 @font.setter 1529 def font(self, font): 1530 """Sets the font of this FormulaTab. 1531 1532 The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. # noqa: E501 1533 1534 :param font: The font of this FormulaTab. # noqa: E501 1535 :type: str 1536 """ 1537 1538 self._font = font 1539 1540 @property 1541 def font_color(self): 1542 """Gets the font_color of this FormulaTab. # noqa: E501 1543 1544 The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. # noqa: E501 1545 1546 :return: The font_color of this FormulaTab. # noqa: E501 1547 :rtype: str 1548 """ 1549 return self._font_color 1550 1551 @font_color.setter 1552 def font_color(self, font_color): 1553 """Sets the font_color of this FormulaTab. 1554 1555 The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. # noqa: E501 1556 1557 :param font_color: The font_color of this FormulaTab. # noqa: E501 1558 :type: str 1559 """ 1560 1561 self._font_color = font_color 1562 1563 @property 1564 def font_color_metadata(self): 1565 """Gets the font_color_metadata of this FormulaTab. # noqa: E501 1566 1567 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1568 1569 :return: The font_color_metadata of this FormulaTab. # noqa: E501 1570 :rtype: PropertyMetadata 1571 """ 1572 return self._font_color_metadata 1573 1574 @font_color_metadata.setter 1575 def font_color_metadata(self, font_color_metadata): 1576 """Sets the font_color_metadata of this FormulaTab. 1577 1578 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1579 1580 :param font_color_metadata: The font_color_metadata of this FormulaTab. # noqa: E501 1581 :type: PropertyMetadata 1582 """ 1583 1584 self._font_color_metadata = font_color_metadata 1585 1586 @property 1587 def font_metadata(self): 1588 """Gets the font_metadata of this FormulaTab. # noqa: E501 1589 1590 Metadata that indicates whether the `font` property is editable. # noqa: E501 1591 1592 :return: The font_metadata of this FormulaTab. # noqa: E501 1593 :rtype: PropertyMetadata 1594 """ 1595 return self._font_metadata 1596 1597 @font_metadata.setter 1598 def font_metadata(self, font_metadata): 1599 """Sets the font_metadata of this FormulaTab. 1600 1601 Metadata that indicates whether the `font` property is editable. # noqa: E501 1602 1603 :param font_metadata: The font_metadata of this FormulaTab. # noqa: E501 1604 :type: PropertyMetadata 1605 """ 1606 1607 self._font_metadata = font_metadata 1608 1609 @property 1610 def font_size(self): 1611 """Gets the font_size of this FormulaTab. # noqa: E501 1612 1613 The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. # noqa: E501 1614 1615 :return: The font_size of this FormulaTab. # noqa: E501 1616 :rtype: str 1617 """ 1618 return self._font_size 1619 1620 @font_size.setter 1621 def font_size(self, font_size): 1622 """Sets the font_size of this FormulaTab. 1623 1624 The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. # noqa: E501 1625 1626 :param font_size: The font_size of this FormulaTab. # noqa: E501 1627 :type: str 1628 """ 1629 1630 self._font_size = font_size 1631 1632 @property 1633 def font_size_metadata(self): 1634 """Gets the font_size_metadata of this FormulaTab. # noqa: E501 1635 1636 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1637 1638 :return: The font_size_metadata of this FormulaTab. # noqa: E501 1639 :rtype: PropertyMetadata 1640 """ 1641 return self._font_size_metadata 1642 1643 @font_size_metadata.setter 1644 def font_size_metadata(self, font_size_metadata): 1645 """Sets the font_size_metadata of this FormulaTab. 1646 1647 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1648 1649 :param font_size_metadata: The font_size_metadata of this FormulaTab. # noqa: E501 1650 :type: PropertyMetadata 1651 """ 1652 1653 self._font_size_metadata = font_size_metadata 1654 1655 @property 1656 def form_order(self): 1657 """Gets the form_order of this FormulaTab. # noqa: E501 1658 1659 # noqa: E501 1660 1661 :return: The form_order of this FormulaTab. # noqa: E501 1662 :rtype: str 1663 """ 1664 return self._form_order 1665 1666 @form_order.setter 1667 def form_order(self, form_order): 1668 """Sets the form_order of this FormulaTab. 1669 1670 # noqa: E501 1671 1672 :param form_order: The form_order of this FormulaTab. # noqa: E501 1673 :type: str 1674 """ 1675 1676 self._form_order = form_order 1677 1678 @property 1679 def form_order_metadata(self): 1680 """Gets the form_order_metadata of this FormulaTab. # noqa: E501 1681 1682 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1683 1684 :return: The form_order_metadata of this FormulaTab. # noqa: E501 1685 :rtype: PropertyMetadata 1686 """ 1687 return self._form_order_metadata 1688 1689 @form_order_metadata.setter 1690 def form_order_metadata(self, form_order_metadata): 1691 """Sets the form_order_metadata of this FormulaTab. 1692 1693 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1694 1695 :param form_order_metadata: The form_order_metadata of this FormulaTab. # noqa: E501 1696 :type: PropertyMetadata 1697 """ 1698 1699 self._form_order_metadata = form_order_metadata 1700 1701 @property 1702 def form_page_label(self): 1703 """Gets the form_page_label of this FormulaTab. # noqa: E501 1704 1705 # noqa: E501 1706 1707 :return: The form_page_label of this FormulaTab. # noqa: E501 1708 :rtype: str 1709 """ 1710 return self._form_page_label 1711 1712 @form_page_label.setter 1713 def form_page_label(self, form_page_label): 1714 """Sets the form_page_label of this FormulaTab. 1715 1716 # noqa: E501 1717 1718 :param form_page_label: The form_page_label of this FormulaTab. # noqa: E501 1719 :type: str 1720 """ 1721 1722 self._form_page_label = form_page_label 1723 1724 @property 1725 def form_page_label_metadata(self): 1726 """Gets the form_page_label_metadata of this FormulaTab. # noqa: E501 1727 1728 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1729 1730 :return: The form_page_label_metadata of this FormulaTab. # noqa: E501 1731 :rtype: PropertyMetadata 1732 """ 1733 return self._form_page_label_metadata 1734 1735 @form_page_label_metadata.setter 1736 def form_page_label_metadata(self, form_page_label_metadata): 1737 """Sets the form_page_label_metadata of this FormulaTab. 1738 1739 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1740 1741 :param form_page_label_metadata: The form_page_label_metadata of this FormulaTab. # noqa: E501 1742 :type: PropertyMetadata 1743 """ 1744 1745 self._form_page_label_metadata = form_page_label_metadata 1746 1747 @property 1748 def form_page_number(self): 1749 """Gets the form_page_number of this FormulaTab. # noqa: E501 1750 1751 # noqa: E501 1752 1753 :return: The form_page_number of this FormulaTab. # noqa: E501 1754 :rtype: str 1755 """ 1756 return self._form_page_number 1757 1758 @form_page_number.setter 1759 def form_page_number(self, form_page_number): 1760 """Sets the form_page_number of this FormulaTab. 1761 1762 # noqa: E501 1763 1764 :param form_page_number: The form_page_number of this FormulaTab. # noqa: E501 1765 :type: str 1766 """ 1767 1768 self._form_page_number = form_page_number 1769 1770 @property 1771 def form_page_number_metadata(self): 1772 """Gets the form_page_number_metadata of this FormulaTab. # noqa: E501 1773 1774 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1775 1776 :return: The form_page_number_metadata of this FormulaTab. # noqa: E501 1777 :rtype: PropertyMetadata 1778 """ 1779 return self._form_page_number_metadata 1780 1781 @form_page_number_metadata.setter 1782 def form_page_number_metadata(self, form_page_number_metadata): 1783 """Sets the form_page_number_metadata of this FormulaTab. 1784 1785 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1786 1787 :param form_page_number_metadata: The form_page_number_metadata of this FormulaTab. # noqa: E501 1788 :type: PropertyMetadata 1789 """ 1790 1791 self._form_page_number_metadata = form_page_number_metadata 1792 1793 @property 1794 def formula(self): 1795 """Gets the formula of this FormulaTab. # noqa: E501 1796 1797 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501 1798 1799 :return: The formula of this FormulaTab. # noqa: E501 1800 :rtype: str 1801 """ 1802 return self._formula 1803 1804 @formula.setter 1805 def formula(self, formula): 1806 """Sets the formula of this FormulaTab. 1807 1808 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501 1809 1810 :param formula: The formula of this FormulaTab. # noqa: E501 1811 :type: str 1812 """ 1813 1814 self._formula = formula 1815 1816 @property 1817 def formula_metadata(self): 1818 """Gets the formula_metadata of this FormulaTab. # noqa: E501 1819 1820 Metadata indicating if the sender can edit the `formula` property. # noqa: E501 1821 1822 :return: The formula_metadata of this FormulaTab. # noqa: E501 1823 :rtype: PropertyMetadata 1824 """ 1825 return self._formula_metadata 1826 1827 @formula_metadata.setter 1828 def formula_metadata(self, formula_metadata): 1829 """Sets the formula_metadata of this FormulaTab. 1830 1831 Metadata indicating if the sender can edit the `formula` property. # noqa: E501 1832 1833 :param formula_metadata: The formula_metadata of this FormulaTab. # noqa: E501 1834 :type: PropertyMetadata 1835 """ 1836 1837 self._formula_metadata = formula_metadata 1838 1839 @property 1840 def height(self): 1841 """Gets the height of this FormulaTab. # noqa: E501 1842 1843 Height of the tab in pixels. # noqa: E501 1844 1845 :return: The height of this FormulaTab. # noqa: E501 1846 :rtype: str 1847 """ 1848 return self._height 1849 1850 @height.setter 1851 def height(self, height): 1852 """Sets the height of this FormulaTab. 1853 1854 Height of the tab in pixels. # noqa: E501 1855 1856 :param height: The height of this FormulaTab. # noqa: E501 1857 :type: str 1858 """ 1859 1860 self._height = height 1861 1862 @property 1863 def height_metadata(self): 1864 """Gets the height_metadata of this FormulaTab. # noqa: E501 1865 1866 Metadata that indicates whether the `height` property is editable. # noqa: E501 1867 1868 :return: The height_metadata of this FormulaTab. # noqa: E501 1869 :rtype: PropertyMetadata 1870 """ 1871 return self._height_metadata 1872 1873 @height_metadata.setter 1874 def height_metadata(self, height_metadata): 1875 """Sets the height_metadata of this FormulaTab. 1876 1877 Metadata that indicates whether the `height` property is editable. # noqa: E501 1878 1879 :param height_metadata: The height_metadata of this FormulaTab. # noqa: E501 1880 :type: PropertyMetadata 1881 """ 1882 1883 self._height_metadata = height_metadata 1884 1885 @property 1886 def hidden(self): 1887 """Gets the hidden of this FormulaTab. # noqa: E501 1888 1889 # noqa: E501 1890 1891 :return: The hidden of this FormulaTab. # noqa: E501 1892 :rtype: str 1893 """ 1894 return self._hidden 1895 1896 @hidden.setter 1897 def hidden(self, hidden): 1898 """Sets the hidden of this FormulaTab. 1899 1900 # noqa: E501 1901 1902 :param hidden: The hidden of this FormulaTab. # noqa: E501 1903 :type: str 1904 """ 1905 1906 self._hidden = hidden 1907 1908 @property 1909 def hidden_metadata(self): 1910 """Gets the hidden_metadata of this FormulaTab. # noqa: E501 1911 1912 Metadata that indicates whether the `hidden` property is editable. # noqa: E501 1913 1914 :return: The hidden_metadata of this FormulaTab. # noqa: E501 1915 :rtype: PropertyMetadata 1916 """ 1917 return self._hidden_metadata 1918 1919 @hidden_metadata.setter 1920 def hidden_metadata(self, hidden_metadata): 1921 """Sets the hidden_metadata of this FormulaTab. 1922 1923 Metadata that indicates whether the `hidden` property is editable. # noqa: E501 1924 1925 :param hidden_metadata: The hidden_metadata of this FormulaTab. # noqa: E501 1926 :type: PropertyMetadata 1927 """ 1928 1929 self._hidden_metadata = hidden_metadata 1930 1931 @property 1932 def is_payment_amount(self): 1933 """Gets the is_payment_amount of this FormulaTab. # noqa: E501 1934 1935 When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501 1936 1937 :return: The is_payment_amount of this FormulaTab. # noqa: E501 1938 :rtype: str 1939 """ 1940 return self._is_payment_amount 1941 1942 @is_payment_amount.setter 1943 def is_payment_amount(self, is_payment_amount): 1944 """Sets the is_payment_amount of this FormulaTab. 1945 1946 When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501 1947 1948 :param is_payment_amount: The is_payment_amount of this FormulaTab. # noqa: E501 1949 :type: str 1950 """ 1951 1952 self._is_payment_amount = is_payment_amount 1953 1954 @property 1955 def is_payment_amount_metadata(self): 1956 """Gets the is_payment_amount_metadata of this FormulaTab. # noqa: E501 1957 1958 Reserved for DocuSign. # noqa: E501 1959 1960 :return: The is_payment_amount_metadata of this FormulaTab. # noqa: E501 1961 :rtype: PropertyMetadata 1962 """ 1963 return self._is_payment_amount_metadata 1964 1965 @is_payment_amount_metadata.setter 1966 def is_payment_amount_metadata(self, is_payment_amount_metadata): 1967 """Sets the is_payment_amount_metadata of this FormulaTab. 1968 1969 Reserved for DocuSign. # noqa: E501 1970 1971 :param is_payment_amount_metadata: The is_payment_amount_metadata of this FormulaTab. # noqa: E501 1972 :type: PropertyMetadata 1973 """ 1974 1975 self._is_payment_amount_metadata = is_payment_amount_metadata 1976 1977 @property 1978 def italic(self): 1979 """Gets the italic of this FormulaTab. # noqa: E501 1980 1981 When set to **true**, the information in the tab is italic. # noqa: E501 1982 1983 :return: The italic of this FormulaTab. # noqa: E501 1984 :rtype: str 1985 """ 1986 return self._italic 1987 1988 @italic.setter 1989 def italic(self, italic): 1990 """Sets the italic of this FormulaTab. 1991 1992 When set to **true**, the information in the tab is italic. # noqa: E501 1993 1994 :param italic: The italic of this FormulaTab. # noqa: E501 1995 :type: str 1996 """ 1997 1998 self._italic = italic 1999 2000 @property 2001 def italic_metadata(self): 2002 """Gets the italic_metadata of this FormulaTab. # noqa: E501 2003 2004 Metadata that indicates whether the `italic` property is editable. # noqa: E501 2005 2006 :return: The italic_metadata of this FormulaTab. # noqa: E501 2007 :rtype: PropertyMetadata 2008 """ 2009 return self._italic_metadata 2010 2011 @italic_metadata.setter 2012 def italic_metadata(self, italic_metadata): 2013 """Sets the italic_metadata of this FormulaTab. 2014 2015 Metadata that indicates whether the `italic` property is editable. # noqa: E501 2016 2017 :param italic_metadata: The italic_metadata of this FormulaTab. # noqa: E501 2018 :type: PropertyMetadata 2019 """ 2020 2021 self._italic_metadata = italic_metadata 2022 2023 @property 2024 def locale_policy(self): 2025 """Gets the locale_policy of this FormulaTab. # noqa: E501 2026 2027 Reserved for DocuSign. # noqa: E501 2028 2029 :return: The locale_policy of this FormulaTab. # noqa: E501 2030 :rtype: LocalePolicyTab 2031 """ 2032 return self._locale_policy 2033 2034 @locale_policy.setter 2035 def locale_policy(self, locale_policy): 2036 """Sets the locale_policy of this FormulaTab. 2037 2038 Reserved for DocuSign. # noqa: E501 2039 2040 :param locale_policy: The locale_policy of this FormulaTab. # noqa: E501 2041 :type: LocalePolicyTab 2042 """ 2043 2044 self._locale_policy = locale_policy 2045 2046 @property 2047 def locked(self): 2048 """Gets the locked of this FormulaTab. # noqa: E501 2049 2050 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 2051 2052 :return: The locked of this FormulaTab. # noqa: E501 2053 :rtype: str 2054 """ 2055 return self._locked 2056 2057 @locked.setter 2058 def locked(self, locked): 2059 """Sets the locked of this FormulaTab. 2060 2061 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 2062 2063 :param locked: The locked of this FormulaTab. # noqa: E501 2064 :type: str 2065 """ 2066 2067 self._locked = locked 2068 2069 @property 2070 def locked_metadata(self): 2071 """Gets the locked_metadata of this FormulaTab. # noqa: E501 2072 2073 Metadata that indicates whether the `locked` property is editable. # noqa: E501 2074 2075 :return: The locked_metadata of this FormulaTab. # noqa: E501 2076 :rtype: PropertyMetadata 2077 """ 2078 return self._locked_metadata 2079 2080 @locked_metadata.setter 2081 def locked_metadata(self, locked_metadata): 2082 """Sets the locked_metadata of this FormulaTab. 2083 2084 Metadata that indicates whether the `locked` property is editable. # noqa: E501 2085 2086 :param locked_metadata: The locked_metadata of this FormulaTab. # noqa: E501 2087 :type: PropertyMetadata 2088 """ 2089 2090 self._locked_metadata = locked_metadata 2091 2092 @property 2093 def max_length(self): 2094 """Gets the max_length of this FormulaTab. # noqa: E501 2095 2096 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 2097 2098 :return: The max_length of this FormulaTab. # noqa: E501 2099 :rtype: str 2100 """ 2101 return self._max_length 2102 2103 @max_length.setter 2104 def max_length(self, max_length): 2105 """Sets the max_length of this FormulaTab. 2106 2107 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 2108 2109 :param max_length: The max_length of this FormulaTab. # noqa: E501 2110 :type: str 2111 """ 2112 2113 self._max_length = max_length 2114 2115 @property 2116 def max_length_metadata(self): 2117 """Gets the max_length_metadata of this FormulaTab. # noqa: E501 2118 2119 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 2120 2121 :return: The max_length_metadata of this FormulaTab. # noqa: E501 2122 :rtype: PropertyMetadata 2123 """ 2124 return self._max_length_metadata 2125 2126 @max_length_metadata.setter 2127 def max_length_metadata(self, max_length_metadata): 2128 """Sets the max_length_metadata of this FormulaTab. 2129 2130 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 2131 2132 :param max_length_metadata: The max_length_metadata of this FormulaTab. # noqa: E501 2133 :type: PropertyMetadata 2134 """ 2135 2136 self._max_length_metadata = max_length_metadata 2137 2138 @property 2139 def merge_field(self): 2140 """Gets the merge_field of this FormulaTab. # noqa: E501 2141 2142 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 2143 2144 :return: The merge_field of this FormulaTab. # noqa: E501 2145 :rtype: MergeField 2146 """ 2147 return self._merge_field 2148 2149 @merge_field.setter 2150 def merge_field(self, merge_field): 2151 """Sets the merge_field of this FormulaTab. 2152 2153 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 2154 2155 :param merge_field: The merge_field of this FormulaTab. # noqa: E501 2156 :type: MergeField 2157 """ 2158 2159 self._merge_field = merge_field 2160 2161 @property 2162 def merge_field_xml(self): 2163 """Gets the merge_field_xml of this FormulaTab. # noqa: E501 2164 2165 # noqa: E501 2166 2167 :return: The merge_field_xml of this FormulaTab. # noqa: E501 2168 :rtype: str 2169 """ 2170 return self._merge_field_xml 2171 2172 @merge_field_xml.setter 2173 def merge_field_xml(self, merge_field_xml): 2174 """Sets the merge_field_xml of this FormulaTab. 2175 2176 # noqa: E501 2177 2178 :param merge_field_xml: The merge_field_xml of this FormulaTab. # noqa: E501 2179 :type: str 2180 """ 2181 2182 self._merge_field_xml = merge_field_xml 2183 2184 @property 2185 def name(self): 2186 """Gets the name of this FormulaTab. # noqa: E501 2187 2188 # noqa: E501 2189 2190 :return: The name of this FormulaTab. # noqa: E501 2191 :rtype: str 2192 """ 2193 return self._name 2194 2195 @name.setter 2196 def name(self, name): 2197 """Sets the name of this FormulaTab. 2198 2199 # noqa: E501 2200 2201 :param name: The name of this FormulaTab. # noqa: E501 2202 :type: str 2203 """ 2204 2205 self._name = name 2206 2207 @property 2208 def name_metadata(self): 2209 """Gets the name_metadata of this FormulaTab. # noqa: E501 2210 2211 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2212 2213 :return: The name_metadata of this FormulaTab. # noqa: E501 2214 :rtype: PropertyMetadata 2215 """ 2216 return self._name_metadata 2217 2218 @name_metadata.setter 2219 def name_metadata(self, name_metadata): 2220 """Sets the name_metadata of this FormulaTab. 2221 2222 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2223 2224 :param name_metadata: The name_metadata of this FormulaTab. # noqa: E501 2225 :type: PropertyMetadata 2226 """ 2227 2228 self._name_metadata = name_metadata 2229 2230 @property 2231 def original_value(self): 2232 """Gets the original_value of this FormulaTab. # noqa: E501 2233 2234 The initial value of the tab when it was sent to the recipient. # noqa: E501 2235 2236 :return: The original_value of this FormulaTab. # noqa: E501 2237 :rtype: str 2238 """ 2239 return self._original_value 2240 2241 @original_value.setter 2242 def original_value(self, original_value): 2243 """Sets the original_value of this FormulaTab. 2244 2245 The initial value of the tab when it was sent to the recipient. # noqa: E501 2246 2247 :param original_value: The original_value of this FormulaTab. # noqa: E501 2248 :type: str 2249 """ 2250 2251 self._original_value = original_value 2252 2253 @property 2254 def original_value_metadata(self): 2255 """Gets the original_value_metadata of this FormulaTab. # noqa: E501 2256 2257 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2258 2259 :return: The original_value_metadata of this FormulaTab. # noqa: E501 2260 :rtype: PropertyMetadata 2261 """ 2262 return self._original_value_metadata 2263 2264 @original_value_metadata.setter 2265 def original_value_metadata(self, original_value_metadata): 2266 """Sets the original_value_metadata of this FormulaTab. 2267 2268 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2269 2270 :param original_value_metadata: The original_value_metadata of this FormulaTab. # noqa: E501 2271 :type: PropertyMetadata 2272 """ 2273 2274 self._original_value_metadata = original_value_metadata 2275 2276 @property 2277 def page_number(self): 2278 """Gets the page_number of this FormulaTab. # noqa: E501 2279 2280 Specifies the page number on which the tab is located. # noqa: E501 2281 2282 :return: The page_number of this FormulaTab. # noqa: E501 2283 :rtype: str 2284 """ 2285 return self._page_number 2286 2287 @page_number.setter 2288 def page_number(self, page_number): 2289 """Sets the page_number of this FormulaTab. 2290 2291 Specifies the page number on which the tab is located. # noqa: E501 2292 2293 :param page_number: The page_number of this FormulaTab. # noqa: E501 2294 :type: str 2295 """ 2296 2297 self._page_number = page_number 2298 2299 @property 2300 def page_number_metadata(self): 2301 """Gets the page_number_metadata of this FormulaTab. # noqa: E501 2302 2303 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2304 2305 :return: The page_number_metadata of this FormulaTab. # noqa: E501 2306 :rtype: PropertyMetadata 2307 """ 2308 return self._page_number_metadata 2309 2310 @page_number_metadata.setter 2311 def page_number_metadata(self, page_number_metadata): 2312 """Sets the page_number_metadata of this FormulaTab. 2313 2314 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2315 2316 :param page_number_metadata: The page_number_metadata of this FormulaTab. # noqa: E501 2317 :type: PropertyMetadata 2318 """ 2319 2320 self._page_number_metadata = page_number_metadata 2321 2322 @property 2323 def payment_details(self): 2324 """Gets the payment_details of this FormulaTab. # noqa: E501 2325 2326 This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501 2327 2328 :return: The payment_details of this FormulaTab. # noqa: E501 2329 :rtype: PaymentDetails 2330 """ 2331 return self._payment_details 2332 2333 @payment_details.setter 2334 def payment_details(self, payment_details): 2335 """Sets the payment_details of this FormulaTab. 2336 2337 This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501 2338 2339 :param payment_details: The payment_details of this FormulaTab. # noqa: E501 2340 :type: PaymentDetails 2341 """ 2342 2343 self._payment_details = payment_details 2344 2345 @property 2346 def recipient_id(self): 2347 """Gets the recipient_id of this FormulaTab. # noqa: E501 2348 2349 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2350 2351 :return: The recipient_id of this FormulaTab. # noqa: E501 2352 :rtype: str 2353 """ 2354 return self._recipient_id 2355 2356 @recipient_id.setter 2357 def recipient_id(self, recipient_id): 2358 """Sets the recipient_id of this FormulaTab. 2359 2360 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2361 2362 :param recipient_id: The recipient_id of this FormulaTab. # noqa: E501 2363 :type: str 2364 """ 2365 2366 self._recipient_id = recipient_id 2367 2368 @property 2369 def recipient_id_guid(self): 2370 """Gets the recipient_id_guid of this FormulaTab. # noqa: E501 2371 2372 # noqa: E501 2373 2374 :return: The recipient_id_guid of this FormulaTab. # noqa: E501 2375 :rtype: str 2376 """ 2377 return self._recipient_id_guid 2378 2379 @recipient_id_guid.setter 2380 def recipient_id_guid(self, recipient_id_guid): 2381 """Sets the recipient_id_guid of this FormulaTab. 2382 2383 # noqa: E501 2384 2385 :param recipient_id_guid: The recipient_id_guid of this FormulaTab. # noqa: E501 2386 :type: str 2387 """ 2388 2389 self._recipient_id_guid = recipient_id_guid 2390 2391 @property 2392 def recipient_id_guid_metadata(self): 2393 """Gets the recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2394 2395 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2396 2397 :return: The recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2398 :rtype: PropertyMetadata 2399 """ 2400 return self._recipient_id_guid_metadata 2401 2402 @recipient_id_guid_metadata.setter 2403 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 2404 """Sets the recipient_id_guid_metadata of this FormulaTab. 2405 2406 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2407 2408 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2409 :type: PropertyMetadata 2410 """ 2411 2412 self._recipient_id_guid_metadata = recipient_id_guid_metadata 2413 2414 @property 2415 def recipient_id_metadata(self): 2416 """Gets the recipient_id_metadata of this FormulaTab. # noqa: E501 2417 2418 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2419 2420 :return: The recipient_id_metadata of this FormulaTab. # noqa: E501 2421 :rtype: PropertyMetadata 2422 """ 2423 return self._recipient_id_metadata 2424 2425 @recipient_id_metadata.setter 2426 def recipient_id_metadata(self, recipient_id_metadata): 2427 """Sets the recipient_id_metadata of this FormulaTab. 2428 2429 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2430 2431 :param recipient_id_metadata: The recipient_id_metadata of this FormulaTab. # noqa: E501 2432 :type: PropertyMetadata 2433 """ 2434 2435 self._recipient_id_metadata = recipient_id_metadata 2436 2437 @property 2438 def require_all(self): 2439 """Gets the require_all of this FormulaTab. # noqa: E501 2440 2441 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2442 2443 :return: The require_all of this FormulaTab. # noqa: E501 2444 :rtype: str 2445 """ 2446 return self._require_all 2447 2448 @require_all.setter 2449 def require_all(self, require_all): 2450 """Sets the require_all of this FormulaTab. 2451 2452 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2453 2454 :param require_all: The require_all of this FormulaTab. # noqa: E501 2455 :type: str 2456 """ 2457 2458 self._require_all = require_all 2459 2460 @property 2461 def require_all_metadata(self): 2462 """Gets the require_all_metadata of this FormulaTab. # noqa: E501 2463 2464 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2465 2466 :return: The require_all_metadata of this FormulaTab. # noqa: E501 2467 :rtype: PropertyMetadata 2468 """ 2469 return self._require_all_metadata 2470 2471 @require_all_metadata.setter 2472 def require_all_metadata(self, require_all_metadata): 2473 """Sets the require_all_metadata of this FormulaTab. 2474 2475 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2476 2477 :param require_all_metadata: The require_all_metadata of this FormulaTab. # noqa: E501 2478 :type: PropertyMetadata 2479 """ 2480 2481 self._require_all_metadata = require_all_metadata 2482 2483 @property 2484 def required(self): 2485 """Gets the required of this FormulaTab. # noqa: E501 2486 2487 When set to **true**, the signer is required to fill out this tab # noqa: E501 2488 2489 :return: The required of this FormulaTab. # noqa: E501 2490 :rtype: str 2491 """ 2492 return self._required 2493 2494 @required.setter 2495 def required(self, required): 2496 """Sets the required of this FormulaTab. 2497 2498 When set to **true**, the signer is required to fill out this tab # noqa: E501 2499 2500 :param required: The required of this FormulaTab. # noqa: E501 2501 :type: str 2502 """ 2503 2504 self._required = required 2505 2506 @property 2507 def required_metadata(self): 2508 """Gets the required_metadata of this FormulaTab. # noqa: E501 2509 2510 Metadata that indicates whether the `required` property is editable. # noqa: E501 2511 2512 :return: The required_metadata of this FormulaTab. # noqa: E501 2513 :rtype: PropertyMetadata 2514 """ 2515 return self._required_metadata 2516 2517 @required_metadata.setter 2518 def required_metadata(self, required_metadata): 2519 """Sets the required_metadata of this FormulaTab. 2520 2521 Metadata that indicates whether the `required` property is editable. # noqa: E501 2522 2523 :param required_metadata: The required_metadata of this FormulaTab. # noqa: E501 2524 :type: PropertyMetadata 2525 """ 2526 2527 self._required_metadata = required_metadata 2528 2529 @property 2530 def require_initial_on_shared_change(self): 2531 """Gets the require_initial_on_shared_change of this FormulaTab. # noqa: E501 2532 2533 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2534 2535 :return: The require_initial_on_shared_change of this FormulaTab. # noqa: E501 2536 :rtype: str 2537 """ 2538 return self._require_initial_on_shared_change 2539 2540 @require_initial_on_shared_change.setter 2541 def require_initial_on_shared_change(self, require_initial_on_shared_change): 2542 """Sets the require_initial_on_shared_change of this FormulaTab. 2543 2544 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2545 2546 :param require_initial_on_shared_change: The require_initial_on_shared_change of this FormulaTab. # noqa: E501 2547 :type: str 2548 """ 2549 2550 self._require_initial_on_shared_change = require_initial_on_shared_change 2551 2552 @property 2553 def require_initial_on_shared_change_metadata(self): 2554 """Gets the require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2555 2556 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2557 2558 :return: The require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2559 :rtype: PropertyMetadata 2560 """ 2561 return self._require_initial_on_shared_change_metadata 2562 2563 @require_initial_on_shared_change_metadata.setter 2564 def require_initial_on_shared_change_metadata(self, require_initial_on_shared_change_metadata): 2565 """Sets the require_initial_on_shared_change_metadata of this FormulaTab. 2566 2567 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2568 2569 :param require_initial_on_shared_change_metadata: The require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2570 :type: PropertyMetadata 2571 """ 2572 2573 self._require_initial_on_shared_change_metadata = require_initial_on_shared_change_metadata 2574 2575 @property 2576 def round_decimal_places(self): 2577 """Gets the round_decimal_places of this FormulaTab. # noqa: E501 2578 2579 # noqa: E501 2580 2581 :return: The round_decimal_places of this FormulaTab. # noqa: E501 2582 :rtype: str 2583 """ 2584 return self._round_decimal_places 2585 2586 @round_decimal_places.setter 2587 def round_decimal_places(self, round_decimal_places): 2588 """Sets the round_decimal_places of this FormulaTab. 2589 2590 # noqa: E501 2591 2592 :param round_decimal_places: The round_decimal_places of this FormulaTab. # noqa: E501 2593 :type: str 2594 """ 2595 2596 self._round_decimal_places = round_decimal_places 2597 2598 @property 2599 def round_decimal_places_metadata(self): 2600 """Gets the round_decimal_places_metadata of this FormulaTab. # noqa: E501 2601 2602 Metadata that indicates whether the `roundDecimalPlaces` property is editable. # noqa: E501 2603 2604 :return: The round_decimal_places_metadata of this FormulaTab. # noqa: E501 2605 :rtype: PropertyMetadata 2606 """ 2607 return self._round_decimal_places_metadata 2608 2609 @round_decimal_places_metadata.setter 2610 def round_decimal_places_metadata(self, round_decimal_places_metadata): 2611 """Sets the round_decimal_places_metadata of this FormulaTab. 2612 2613 Metadata that indicates whether the `roundDecimalPlaces` property is editable. # noqa: E501 2614 2615 :param round_decimal_places_metadata: The round_decimal_places_metadata of this FormulaTab. # noqa: E501 2616 :type: PropertyMetadata 2617 """ 2618 2619 self._round_decimal_places_metadata = round_decimal_places_metadata 2620 2621 @property 2622 def sender_required(self): 2623 """Gets the sender_required of this FormulaTab. # noqa: E501 2624 2625 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2626 2627 :return: The sender_required of this FormulaTab. # noqa: E501 2628 :rtype: str 2629 """ 2630 return self._sender_required 2631 2632 @sender_required.setter 2633 def sender_required(self, sender_required): 2634 """Sets the sender_required of this FormulaTab. 2635 2636 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2637 2638 :param sender_required: The sender_required of this FormulaTab. # noqa: E501 2639 :type: str 2640 """ 2641 2642 self._sender_required = sender_required 2643 2644 @property 2645 def sender_required_metadata(self): 2646 """Gets the sender_required_metadata of this FormulaTab. # noqa: E501 2647 2648 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2649 2650 :return: The sender_required_metadata of this FormulaTab. # noqa: E501 2651 :rtype: PropertyMetadata 2652 """ 2653 return self._sender_required_metadata 2654 2655 @sender_required_metadata.setter 2656 def sender_required_metadata(self, sender_required_metadata): 2657 """Sets the sender_required_metadata of this FormulaTab. 2658 2659 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2660 2661 :param sender_required_metadata: The sender_required_metadata of this FormulaTab. # noqa: E501 2662 :type: PropertyMetadata 2663 """ 2664 2665 self._sender_required_metadata = sender_required_metadata 2666 2667 @property 2668 def shared(self): 2669 """Gets the shared of this FormulaTab. # noqa: E501 2670 2671 When set to **true**, this custom tab is shared. # noqa: E501 2672 2673 :return: The shared of this FormulaTab. # noqa: E501 2674 :rtype: str 2675 """ 2676 return self._shared 2677 2678 @shared.setter 2679 def shared(self, shared): 2680 """Sets the shared of this FormulaTab. 2681 2682 When set to **true**, this custom tab is shared. # noqa: E501 2683 2684 :param shared: The shared of this FormulaTab. # noqa: E501 2685 :type: str 2686 """ 2687 2688 self._shared = shared 2689 2690 @property 2691 def shared_metadata(self): 2692 """Gets the shared_metadata of this FormulaTab. # noqa: E501 2693 2694 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2695 2696 :return: The shared_metadata of this FormulaTab. # noqa: E501 2697 :rtype: PropertyMetadata 2698 """ 2699 return self._shared_metadata 2700 2701 @shared_metadata.setter 2702 def shared_metadata(self, shared_metadata): 2703 """Sets the shared_metadata of this FormulaTab. 2704 2705 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2706 2707 :param shared_metadata: The shared_metadata of this FormulaTab. # noqa: E501 2708 :type: PropertyMetadata 2709 """ 2710 2711 self._shared_metadata = shared_metadata 2712 2713 @property 2714 def share_to_recipients(self): 2715 """Gets the share_to_recipients of this FormulaTab. # noqa: E501 2716 2717 # noqa: E501 2718 2719 :return: The share_to_recipients of this FormulaTab. # noqa: E501 2720 :rtype: str 2721 """ 2722 return self._share_to_recipients 2723 2724 @share_to_recipients.setter 2725 def share_to_recipients(self, share_to_recipients): 2726 """Sets the share_to_recipients of this FormulaTab. 2727 2728 # noqa: E501 2729 2730 :param share_to_recipients: The share_to_recipients of this FormulaTab. # noqa: E501 2731 :type: str 2732 """ 2733 2734 self._share_to_recipients = share_to_recipients 2735 2736 @property 2737 def share_to_recipients_metadata(self): 2738 """Gets the share_to_recipients_metadata of this FormulaTab. # noqa: E501 2739 2740 Reserved for DocuSign. # noqa: E501 2741 2742 :return: The share_to_recipients_metadata of this FormulaTab. # noqa: E501 2743 :rtype: PropertyMetadata 2744 """ 2745 return self._share_to_recipients_metadata 2746 2747 @share_to_recipients_metadata.setter 2748 def share_to_recipients_metadata(self, share_to_recipients_metadata): 2749 """Sets the share_to_recipients_metadata of this FormulaTab. 2750 2751 Reserved for DocuSign. # noqa: E501 2752 2753 :param share_to_recipients_metadata: The share_to_recipients_metadata of this FormulaTab. # noqa: E501 2754 :type: PropertyMetadata 2755 """ 2756 2757 self._share_to_recipients_metadata = share_to_recipients_metadata 2758 2759 @property 2760 def smart_contract_information(self): 2761 """Gets the smart_contract_information of this FormulaTab. # noqa: E501 2762 2763 Reserved for DocuSign. # noqa: E501 2764 2765 :return: The smart_contract_information of this FormulaTab. # noqa: E501 2766 :rtype: SmartContractInformation 2767 """ 2768 return self._smart_contract_information 2769 2770 @smart_contract_information.setter 2771 def smart_contract_information(self, smart_contract_information): 2772 """Sets the smart_contract_information of this FormulaTab. 2773 2774 Reserved for DocuSign. # noqa: E501 2775 2776 :param smart_contract_information: The smart_contract_information of this FormulaTab. # noqa: E501 2777 :type: SmartContractInformation 2778 """ 2779 2780 self._smart_contract_information = smart_contract_information 2781 2782 @property 2783 def source(self): 2784 """Gets the source of this FormulaTab. # noqa: E501 2785 2786 # noqa: E501 2787 2788 :return: The source of this FormulaTab. # noqa: E501 2789 :rtype: str 2790 """ 2791 return self._source 2792 2793 @source.setter 2794 def source(self, source): 2795 """Sets the source of this FormulaTab. 2796 2797 # noqa: E501 2798 2799 :param source: The source of this FormulaTab. # noqa: E501 2800 :type: str 2801 """ 2802 2803 self._source = source 2804 2805 @property 2806 def status(self): 2807 """Gets the status of this FormulaTab. # noqa: E501 2808 2809 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 2810 2811 :return: The status of this FormulaTab. # noqa: E501 2812 :rtype: str 2813 """ 2814 return self._status 2815 2816 @status.setter 2817 def status(self, status): 2818 """Sets the status of this FormulaTab. 2819 2820 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 2821 2822 :param status: The status of this FormulaTab. # noqa: E501 2823 :type: str 2824 """ 2825 2826 self._status = status 2827 2828 @property 2829 def status_metadata(self): 2830 """Gets the status_metadata of this FormulaTab. # noqa: E501 2831 2832 Metadata that indicates whether the `status` property is editable. # noqa: E501 2833 2834 :return: The status_metadata of this FormulaTab. # noqa: E501 2835 :rtype: PropertyMetadata 2836 """ 2837 return self._status_metadata 2838 2839 @status_metadata.setter 2840 def status_metadata(self, status_metadata): 2841 """Sets the status_metadata of this FormulaTab. 2842 2843 Metadata that indicates whether the `status` property is editable. # noqa: E501 2844 2845 :param status_metadata: The status_metadata of this FormulaTab. # noqa: E501 2846 :type: PropertyMetadata 2847 """ 2848 2849 self._status_metadata = status_metadata 2850 2851 @property 2852 def tab_fully_qualified_path(self): 2853 """Gets the tab_fully_qualified_path of this FormulaTab. # noqa: E501 2854 2855 # noqa: E501 2856 2857 :return: The tab_fully_qualified_path of this FormulaTab. # noqa: E501 2858 :rtype: str 2859 """ 2860 return self._tab_fully_qualified_path 2861 2862 @tab_fully_qualified_path.setter 2863 def tab_fully_qualified_path(self, tab_fully_qualified_path): 2864 """Sets the tab_fully_qualified_path of this FormulaTab. 2865 2866 # noqa: E501 2867 2868 :param tab_fully_qualified_path: The tab_fully_qualified_path of this FormulaTab. # noqa: E501 2869 :type: str 2870 """ 2871 2872 self._tab_fully_qualified_path = tab_fully_qualified_path 2873 2874 @property 2875 def tab_group_labels(self): 2876 """Gets the tab_group_labels of this FormulaTab. # noqa: E501 2877 2878 # noqa: E501 2879 2880 :return: The tab_group_labels of this FormulaTab. # noqa: E501 2881 :rtype: list[str] 2882 """ 2883 return self._tab_group_labels 2884 2885 @tab_group_labels.setter 2886 def tab_group_labels(self, tab_group_labels): 2887 """Sets the tab_group_labels of this FormulaTab. 2888 2889 # noqa: E501 2890 2891 :param tab_group_labels: The tab_group_labels of this FormulaTab. # noqa: E501 2892 :type: list[str] 2893 """ 2894 2895 self._tab_group_labels = tab_group_labels 2896 2897 @property 2898 def tab_group_labels_metadata(self): 2899 """Gets the tab_group_labels_metadata of this FormulaTab. # noqa: E501 2900 2901 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2902 2903 :return: The tab_group_labels_metadata of this FormulaTab. # noqa: E501 2904 :rtype: PropertyMetadata 2905 """ 2906 return self._tab_group_labels_metadata 2907 2908 @tab_group_labels_metadata.setter 2909 def tab_group_labels_metadata(self, tab_group_labels_metadata): 2910 """Sets the tab_group_labels_metadata of this FormulaTab. 2911 2912 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2913 2914 :param tab_group_labels_metadata: The tab_group_labels_metadata of this FormulaTab. # noqa: E501 2915 :type: PropertyMetadata 2916 """ 2917 2918 self._tab_group_labels_metadata = tab_group_labels_metadata 2919 2920 @property 2921 def tab_id(self): 2922 """Gets the tab_id of this FormulaTab. # noqa: E501 2923 2924 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2925 2926 :return: The tab_id of this FormulaTab. # noqa: E501 2927 :rtype: str 2928 """ 2929 return self._tab_id 2930 2931 @tab_id.setter 2932 def tab_id(self, tab_id): 2933 """Sets the tab_id of this FormulaTab. 2934 2935 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2936 2937 :param tab_id: The tab_id of this FormulaTab. # noqa: E501 2938 :type: str 2939 """ 2940 2941 self._tab_id = tab_id 2942 2943 @property 2944 def tab_id_metadata(self): 2945 """Gets the tab_id_metadata of this FormulaTab. # noqa: E501 2946 2947 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2948 2949 :return: The tab_id_metadata of this FormulaTab. # noqa: E501 2950 :rtype: PropertyMetadata 2951 """ 2952 return self._tab_id_metadata 2953 2954 @tab_id_metadata.setter 2955 def tab_id_metadata(self, tab_id_metadata): 2956 """Sets the tab_id_metadata of this FormulaTab. 2957 2958 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2959 2960 :param tab_id_metadata: The tab_id_metadata of this FormulaTab. # noqa: E501 2961 :type: PropertyMetadata 2962 """ 2963 2964 self._tab_id_metadata = tab_id_metadata 2965 2966 @property 2967 def tab_label(self): 2968 """Gets the tab_label of this FormulaTab. # noqa: E501 2969 2970 The label string associated with the tab. # noqa: E501 2971 2972 :return: The tab_label of this FormulaTab. # noqa: E501 2973 :rtype: str 2974 """ 2975 return self._tab_label 2976 2977 @tab_label.setter 2978 def tab_label(self, tab_label): 2979 """Sets the tab_label of this FormulaTab. 2980 2981 The label string associated with the tab. # noqa: E501 2982 2983 :param tab_label: The tab_label of this FormulaTab. # noqa: E501 2984 :type: str 2985 """ 2986 2987 self._tab_label = tab_label 2988 2989 @property 2990 def tab_label_metadata(self): 2991 """Gets the tab_label_metadata of this FormulaTab. # noqa: E501 2992 2993 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 2994 2995 :return: The tab_label_metadata of this FormulaTab. # noqa: E501 2996 :rtype: PropertyMetadata 2997 """ 2998 return self._tab_label_metadata 2999 3000 @tab_label_metadata.setter 3001 def tab_label_metadata(self, tab_label_metadata): 3002 """Sets the tab_label_metadata of this FormulaTab. 3003 3004 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 3005 3006 :param tab_label_metadata: The tab_label_metadata of this FormulaTab. # noqa: E501 3007 :type: PropertyMetadata 3008 """ 3009 3010 self._tab_label_metadata = tab_label_metadata 3011 3012 @property 3013 def tab_order(self): 3014 """Gets the tab_order of this FormulaTab. # noqa: E501 3015 3016 # noqa: E501 3017 3018 :return: The tab_order of this FormulaTab. # noqa: E501 3019 :rtype: str 3020 """ 3021 return self._tab_order 3022 3023 @tab_order.setter 3024 def tab_order(self, tab_order): 3025 """Sets the tab_order of this FormulaTab. 3026 3027 # noqa: E501 3028 3029 :param tab_order: The tab_order of this FormulaTab. # noqa: E501 3030 :type: str 3031 """ 3032 3033 self._tab_order = tab_order 3034 3035 @property 3036 def tab_order_metadata(self): 3037 """Gets the tab_order_metadata of this FormulaTab. # noqa: E501 3038 3039 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 3040 3041 :return: The tab_order_metadata of this FormulaTab. # noqa: E501 3042 :rtype: PropertyMetadata 3043 """ 3044 return self._tab_order_metadata 3045 3046 @tab_order_metadata.setter 3047 def tab_order_metadata(self, tab_order_metadata): 3048 """Sets the tab_order_metadata of this FormulaTab. 3049 3050 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 3051 3052 :param tab_order_metadata: The tab_order_metadata of this FormulaTab. # noqa: E501 3053 :type: PropertyMetadata 3054 """ 3055 3056 self._tab_order_metadata = tab_order_metadata 3057 3058 @property 3059 def tab_type(self): 3060 """Gets the tab_type of this FormulaTab. # noqa: E501 3061 3062 # noqa: E501 3063 3064 :return: The tab_type of this FormulaTab. # noqa: E501 3065 :rtype: str 3066 """ 3067 return self._tab_type 3068 3069 @tab_type.setter 3070 def tab_type(self, tab_type): 3071 """Sets the tab_type of this FormulaTab. 3072 3073 # noqa: E501 3074 3075 :param tab_type: The tab_type of this FormulaTab. # noqa: E501 3076 :type: str 3077 """ 3078 3079 self._tab_type = tab_type 3080 3081 @property 3082 def tab_type_metadata(self): 3083 """Gets the tab_type_metadata of this FormulaTab. # noqa: E501 3084 3085 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 3086 3087 :return: The tab_type_metadata of this FormulaTab. # noqa: E501 3088 :rtype: PropertyMetadata 3089 """ 3090 return self._tab_type_metadata 3091 3092 @tab_type_metadata.setter 3093 def tab_type_metadata(self, tab_type_metadata): 3094 """Sets the tab_type_metadata of this FormulaTab. 3095 3096 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 3097 3098 :param tab_type_metadata: The tab_type_metadata of this FormulaTab. # noqa: E501 3099 :type: PropertyMetadata 3100 """ 3101 3102 self._tab_type_metadata = tab_type_metadata 3103 3104 @property 3105 def template_locked(self): 3106 """Gets the template_locked of this FormulaTab. # noqa: E501 3107 3108 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 3109 3110 :return: The template_locked of this FormulaTab. # noqa: E501 3111 :rtype: str 3112 """ 3113 return self._template_locked 3114 3115 @template_locked.setter 3116 def template_locked(self, template_locked): 3117 """Sets the template_locked of this FormulaTab. 3118 3119 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 3120 3121 :param template_locked: The template_locked of this FormulaTab. # noqa: E501 3122 :type: str 3123 """ 3124 3125 self._template_locked = template_locked 3126 3127 @property 3128 def template_locked_metadata(self): 3129 """Gets the template_locked_metadata of this FormulaTab. # noqa: E501 3130 3131 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 3132 3133 :return: The template_locked_metadata of this FormulaTab. # noqa: E501 3134 :rtype: PropertyMetadata 3135 """ 3136 return self._template_locked_metadata 3137 3138 @template_locked_metadata.setter 3139 def template_locked_metadata(self, template_locked_metadata): 3140 """Sets the template_locked_metadata of this FormulaTab. 3141 3142 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 3143 3144 :param template_locked_metadata: The template_locked_metadata of this FormulaTab. # noqa: E501 3145 :type: PropertyMetadata 3146 """ 3147 3148 self._template_locked_metadata = template_locked_metadata 3149 3150 @property 3151 def template_required(self): 3152 """Gets the template_required of this FormulaTab. # noqa: E501 3153 3154 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 3155 3156 :return: The template_required of this FormulaTab. # noqa: E501 3157 :rtype: str 3158 """ 3159 return self._template_required 3160 3161 @template_required.setter 3162 def template_required(self, template_required): 3163 """Sets the template_required of this FormulaTab. 3164 3165 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 3166 3167 :param template_required: The template_required of this FormulaTab. # noqa: E501 3168 :type: str 3169 """ 3170 3171 self._template_required = template_required 3172 3173 @property 3174 def template_required_metadata(self): 3175 """Gets the template_required_metadata of this FormulaTab. # noqa: E501 3176 3177 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 3178 3179 :return: The template_required_metadata of this FormulaTab. # noqa: E501 3180 :rtype: PropertyMetadata 3181 """ 3182 return self._template_required_metadata 3183 3184 @template_required_metadata.setter 3185 def template_required_metadata(self, template_required_metadata): 3186 """Sets the template_required_metadata of this FormulaTab. 3187 3188 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 3189 3190 :param template_required_metadata: The template_required_metadata of this FormulaTab. # noqa: E501 3191 :type: PropertyMetadata 3192 """ 3193 3194 self._template_required_metadata = template_required_metadata 3195 3196 @property 3197 def tooltip(self): 3198 """Gets the tooltip of this FormulaTab. # noqa: E501 3199 3200 # noqa: E501 3201 3202 :return: The tooltip of this FormulaTab. # noqa: E501 3203 :rtype: str 3204 """ 3205 return self._tooltip 3206 3207 @tooltip.setter 3208 def tooltip(self, tooltip): 3209 """Sets the tooltip of this FormulaTab. 3210 3211 # noqa: E501 3212 3213 :param tooltip: The tooltip of this FormulaTab. # noqa: E501 3214 :type: str 3215 """ 3216 3217 self._tooltip = tooltip 3218 3219 @property 3220 def tool_tip_metadata(self): 3221 """Gets the tool_tip_metadata of this FormulaTab. # noqa: E501 3222 3223 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3224 3225 :return: The tool_tip_metadata of this FormulaTab. # noqa: E501 3226 :rtype: PropertyMetadata 3227 """ 3228 return self._tool_tip_metadata 3229 3230 @tool_tip_metadata.setter 3231 def tool_tip_metadata(self, tool_tip_metadata): 3232 """Sets the tool_tip_metadata of this FormulaTab. 3233 3234 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3235 3236 :param tool_tip_metadata: The tool_tip_metadata of this FormulaTab. # noqa: E501 3237 :type: PropertyMetadata 3238 """ 3239 3240 self._tool_tip_metadata = tool_tip_metadata 3241 3242 @property 3243 def underline(self): 3244 """Gets the underline of this FormulaTab. # noqa: E501 3245 3246 When set to **true**, the information in the tab is underlined. # noqa: E501 3247 3248 :return: The underline of this FormulaTab. # noqa: E501 3249 :rtype: str 3250 """ 3251 return self._underline 3252 3253 @underline.setter 3254 def underline(self, underline): 3255 """Sets the underline of this FormulaTab. 3256 3257 When set to **true**, the information in the tab is underlined. # noqa: E501 3258 3259 :param underline: The underline of this FormulaTab. # noqa: E501 3260 :type: str 3261 """ 3262 3263 self._underline = underline 3264 3265 @property 3266 def underline_metadata(self): 3267 """Gets the underline_metadata of this FormulaTab. # noqa: E501 3268 3269 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3270 3271 :return: The underline_metadata of this FormulaTab. # noqa: E501 3272 :rtype: PropertyMetadata 3273 """ 3274 return self._underline_metadata 3275 3276 @underline_metadata.setter 3277 def underline_metadata(self, underline_metadata): 3278 """Sets the underline_metadata of this FormulaTab. 3279 3280 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3281 3282 :param underline_metadata: The underline_metadata of this FormulaTab. # noqa: E501 3283 :type: PropertyMetadata 3284 """ 3285 3286 self._underline_metadata = underline_metadata 3287 3288 @property 3289 def validation_message(self): 3290 """Gets the validation_message of this FormulaTab. # noqa: E501 3291 3292 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3293 3294 :return: The validation_message of this FormulaTab. # noqa: E501 3295 :rtype: str 3296 """ 3297 return self._validation_message 3298 3299 @validation_message.setter 3300 def validation_message(self, validation_message): 3301 """Sets the validation_message of this FormulaTab. 3302 3303 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3304 3305 :param validation_message: The validation_message of this FormulaTab. # noqa: E501 3306 :type: str 3307 """ 3308 3309 self._validation_message = validation_message 3310 3311 @property 3312 def validation_message_metadata(self): 3313 """Gets the validation_message_metadata of this FormulaTab. # noqa: E501 3314 3315 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3316 3317 :return: The validation_message_metadata of this FormulaTab. # noqa: E501 3318 :rtype: PropertyMetadata 3319 """ 3320 return self._validation_message_metadata 3321 3322 @validation_message_metadata.setter 3323 def validation_message_metadata(self, validation_message_metadata): 3324 """Sets the validation_message_metadata of this FormulaTab. 3325 3326 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3327 3328 :param validation_message_metadata: The validation_message_metadata of this FormulaTab. # noqa: E501 3329 :type: PropertyMetadata 3330 """ 3331 3332 self._validation_message_metadata = validation_message_metadata 3333 3334 @property 3335 def validation_pattern(self): 3336 """Gets the validation_pattern of this FormulaTab. # noqa: E501 3337 3338 A regular expression used to validate input for the tab. # noqa: E501 3339 3340 :return: The validation_pattern of this FormulaTab. # noqa: E501 3341 :rtype: str 3342 """ 3343 return self._validation_pattern 3344 3345 @validation_pattern.setter 3346 def validation_pattern(self, validation_pattern): 3347 """Sets the validation_pattern of this FormulaTab. 3348 3349 A regular expression used to validate input for the tab. # noqa: E501 3350 3351 :param validation_pattern: The validation_pattern of this FormulaTab. # noqa: E501 3352 :type: str 3353 """ 3354 3355 self._validation_pattern = validation_pattern 3356 3357 @property 3358 def validation_pattern_metadata(self): 3359 """Gets the validation_pattern_metadata of this FormulaTab. # noqa: E501 3360 3361 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3362 3363 :return: The validation_pattern_metadata of this FormulaTab. # noqa: E501 3364 :rtype: PropertyMetadata 3365 """ 3366 return self._validation_pattern_metadata 3367 3368 @validation_pattern_metadata.setter 3369 def validation_pattern_metadata(self, validation_pattern_metadata): 3370 """Sets the validation_pattern_metadata of this FormulaTab. 3371 3372 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3373 3374 :param validation_pattern_metadata: The validation_pattern_metadata of this FormulaTab. # noqa: E501 3375 :type: PropertyMetadata 3376 """ 3377 3378 self._validation_pattern_metadata = validation_pattern_metadata 3379 3380 @property 3381 def value(self): 3382 """Gets the value of this FormulaTab. # noqa: E501 3383 3384 Specifies the value of the tab. # noqa: E501 3385 3386 :return: The value of this FormulaTab. # noqa: E501 3387 :rtype: str 3388 """ 3389 return self._value 3390 3391 @value.setter 3392 def value(self, value): 3393 """Sets the value of this FormulaTab. 3394 3395 Specifies the value of the tab. # noqa: E501 3396 3397 :param value: The value of this FormulaTab. # noqa: E501 3398 :type: str 3399 """ 3400 3401 self._value = value 3402 3403 @property 3404 def value_metadata(self): 3405 """Gets the value_metadata of this FormulaTab. # noqa: E501 3406 3407 Metadata that indicates whether the `value` property is editable. # noqa: E501 3408 3409 :return: The value_metadata of this FormulaTab. # noqa: E501 3410 :rtype: PropertyMetadata 3411 """ 3412 return self._value_metadata 3413 3414 @value_metadata.setter 3415 def value_metadata(self, value_metadata): 3416 """Sets the value_metadata of this FormulaTab. 3417 3418 Metadata that indicates whether the `value` property is editable. # noqa: E501 3419 3420 :param value_metadata: The value_metadata of this FormulaTab. # noqa: E501 3421 :type: PropertyMetadata 3422 """ 3423 3424 self._value_metadata = value_metadata 3425 3426 @property 3427 def warning_details(self): 3428 """Gets the warning_details of this FormulaTab. # noqa: E501 3429 3430 # noqa: E501 3431 3432 :return: The warning_details of this FormulaTab. # noqa: E501 3433 :rtype: ErrorDetails 3434 """ 3435 return self._warning_details 3436 3437 @warning_details.setter 3438 def warning_details(self, warning_details): 3439 """Sets the warning_details of this FormulaTab. 3440 3441 # noqa: E501 3442 3443 :param warning_details: The warning_details of this FormulaTab. # noqa: E501 3444 :type: ErrorDetails 3445 """ 3446 3447 self._warning_details = warning_details 3448 3449 @property 3450 def width(self): 3451 """Gets the width of this FormulaTab. # noqa: E501 3452 3453 Width of the tab in pixels. # noqa: E501 3454 3455 :return: The width of this FormulaTab. # noqa: E501 3456 :rtype: str 3457 """ 3458 return self._width 3459 3460 @width.setter 3461 def width(self, width): 3462 """Sets the width of this FormulaTab. 3463 3464 Width of the tab in pixels. # noqa: E501 3465 3466 :param width: The width of this FormulaTab. # noqa: E501 3467 :type: str 3468 """ 3469 3470 self._width = width 3471 3472 @property 3473 def width_metadata(self): 3474 """Gets the width_metadata of this FormulaTab. # noqa: E501 3475 3476 Metadata that indicates whether the `width` property is editable. # noqa: E501 3477 3478 :return: The width_metadata of this FormulaTab. # noqa: E501 3479 :rtype: PropertyMetadata 3480 """ 3481 return self._width_metadata 3482 3483 @width_metadata.setter 3484 def width_metadata(self, width_metadata): 3485 """Sets the width_metadata of this FormulaTab. 3486 3487 Metadata that indicates whether the `width` property is editable. # noqa: E501 3488 3489 :param width_metadata: The width_metadata of this FormulaTab. # noqa: E501 3490 :type: PropertyMetadata 3491 """ 3492 3493 self._width_metadata = width_metadata 3494 3495 @property 3496 def x_position(self): 3497 """Gets the x_position of this FormulaTab. # noqa: E501 3498 3499 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3500 3501 :return: The x_position of this FormulaTab. # noqa: E501 3502 :rtype: str 3503 """ 3504 return self._x_position 3505 3506 @x_position.setter 3507 def x_position(self, x_position): 3508 """Sets the x_position of this FormulaTab. 3509 3510 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3511 3512 :param x_position: The x_position of this FormulaTab. # noqa: E501 3513 :type: str 3514 """ 3515 3516 self._x_position = x_position 3517 3518 @property 3519 def x_position_metadata(self): 3520 """Gets the x_position_metadata of this FormulaTab. # noqa: E501 3521 3522 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3523 3524 :return: The x_position_metadata of this FormulaTab. # noqa: E501 3525 :rtype: PropertyMetadata 3526 """ 3527 return self._x_position_metadata 3528 3529 @x_position_metadata.setter 3530 def x_position_metadata(self, x_position_metadata): 3531 """Sets the x_position_metadata of this FormulaTab. 3532 3533 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3534 3535 :param x_position_metadata: The x_position_metadata of this FormulaTab. # noqa: E501 3536 :type: PropertyMetadata 3537 """ 3538 3539 self._x_position_metadata = x_position_metadata 3540 3541 @property 3542 def y_position(self): 3543 """Gets the y_position of this FormulaTab. # noqa: E501 3544 3545 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3546 3547 :return: The y_position of this FormulaTab. # noqa: E501 3548 :rtype: str 3549 """ 3550 return self._y_position 3551 3552 @y_position.setter 3553 def y_position(self, y_position): 3554 """Sets the y_position of this FormulaTab. 3555 3556 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3557 3558 :param y_position: The y_position of this FormulaTab. # noqa: E501 3559 :type: str 3560 """ 3561 3562 self._y_position = y_position 3563 3564 @property 3565 def y_position_metadata(self): 3566 """Gets the y_position_metadata of this FormulaTab. # noqa: E501 3567 3568 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3569 3570 :return: The y_position_metadata of this FormulaTab. # noqa: E501 3571 :rtype: PropertyMetadata 3572 """ 3573 return self._y_position_metadata 3574 3575 @y_position_metadata.setter 3576 def y_position_metadata(self, y_position_metadata): 3577 """Sets the y_position_metadata of this FormulaTab. 3578 3579 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3580 3581 :param y_position_metadata: The y_position_metadata of this FormulaTab. # noqa: E501 3582 :type: PropertyMetadata 3583 """ 3584 3585 self._y_position_metadata = y_position_metadata 3586 3587 def to_dict(self): 3588 """Returns the model properties as a dict""" 3589 result = {} 3590 3591 for attr, _ in six.iteritems(self.swagger_types): 3592 value = getattr(self, attr) 3593 if isinstance(value, list): 3594 result[attr] = list(map( 3595 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3596 value 3597 )) 3598 elif hasattr(value, "to_dict"): 3599 result[attr] = value.to_dict() 3600 elif isinstance(value, dict): 3601 result[attr] = dict(map( 3602 lambda item: (item[0], item[1].to_dict()) 3603 if hasattr(item[1], "to_dict") else item, 3604 value.items() 3605 )) 3606 else: 3607 result[attr] = value 3608 if issubclass(FormulaTab, dict): 3609 for key, value in self.items(): 3610 result[key] = value 3611 3612 return result 3613 3614 def to_str(self): 3615 """Returns the string representation of the model""" 3616 return pprint.pformat(self.to_dict()) 3617 3618 def __repr__(self): 3619 """For `print` and `pprint`""" 3620 return self.to_str() 3621 3622 def __eq__(self, other): 3623 """Returns true if both objects are equal""" 3624 if not isinstance(other, FormulaTab): 3625 return False 3626 3627 return self.to_dict() == other.to_dict() 3628 3629 def __ne__(self, other): 3630 """Returns true if both objects are not equal""" 3631 if not isinstance(other, FormulaTab): 3632 return True 3633 3634 return self.to_dict() != other.to_dict()
class
FormulaTab:
23class FormulaTab(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'agreement_attribute': 'str', 38 'agreement_attribute_locked': 'str', 39 'anchor_allow_white_space_in_characters': 'str', 40 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 41 'anchor_case_sensitive': 'str', 42 'anchor_case_sensitive_metadata': 'PropertyMetadata', 43 'anchor_horizontal_alignment': 'str', 44 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 45 'anchor_ignore_if_not_present': 'str', 46 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 47 'anchor_match_whole_word': 'str', 48 'anchor_match_whole_word_metadata': 'PropertyMetadata', 49 'anchor_string': 'str', 50 'anchor_string_metadata': 'PropertyMetadata', 51 'anchor_tab_processor_version': 'str', 52 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 53 'anchor_units': 'str', 54 'anchor_units_metadata': 'PropertyMetadata', 55 'anchor_x_offset': 'str', 56 'anchor_x_offset_metadata': 'PropertyMetadata', 57 'anchor_y_offset': 'str', 58 'anchor_y_offset_metadata': 'PropertyMetadata', 59 'bold': 'str', 60 'bold_metadata': 'PropertyMetadata', 61 'caption': 'str', 62 'caption_metadata': 'PropertyMetadata', 63 'conceal_value_on_document': 'str', 64 'conceal_value_on_document_metadata': 'PropertyMetadata', 65 'conditional_parent_label': 'str', 66 'conditional_parent_label_metadata': 'PropertyMetadata', 67 'conditional_parent_value': 'str', 68 'conditional_parent_value_metadata': 'PropertyMetadata', 69 'connected_object_details': 'ConnectedObjectDetails', 70 'custom_tab_id': 'str', 71 'custom_tab_id_metadata': 'PropertyMetadata', 72 'disable_auto_size': 'str', 73 'disable_auto_size_metadata': 'PropertyMetadata', 74 'document_id': 'str', 75 'document_id_metadata': 'PropertyMetadata', 76 'error_details': 'ErrorDetails', 77 'extension_data': 'ExtensionData', 78 'font': 'str', 79 'font_color': 'str', 80 'font_color_metadata': 'PropertyMetadata', 81 'font_metadata': 'PropertyMetadata', 82 'font_size': 'str', 83 'font_size_metadata': 'PropertyMetadata', 84 'form_order': 'str', 85 'form_order_metadata': 'PropertyMetadata', 86 'form_page_label': 'str', 87 'form_page_label_metadata': 'PropertyMetadata', 88 'form_page_number': 'str', 89 'form_page_number_metadata': 'PropertyMetadata', 90 'formula': 'str', 91 'formula_metadata': 'PropertyMetadata', 92 'height': 'str', 93 'height_metadata': 'PropertyMetadata', 94 'hidden': 'str', 95 'hidden_metadata': 'PropertyMetadata', 96 'is_payment_amount': 'str', 97 'is_payment_amount_metadata': 'PropertyMetadata', 98 'italic': 'str', 99 'italic_metadata': 'PropertyMetadata', 100 'locale_policy': 'LocalePolicyTab', 101 'locked': 'str', 102 'locked_metadata': 'PropertyMetadata', 103 'max_length': 'str', 104 'max_length_metadata': 'PropertyMetadata', 105 'merge_field': 'MergeField', 106 'merge_field_xml': 'str', 107 'name': 'str', 108 'name_metadata': 'PropertyMetadata', 109 'original_value': 'str', 110 'original_value_metadata': 'PropertyMetadata', 111 'page_number': 'str', 112 'page_number_metadata': 'PropertyMetadata', 113 'payment_details': 'PaymentDetails', 114 'recipient_id': 'str', 115 'recipient_id_guid': 'str', 116 'recipient_id_guid_metadata': 'PropertyMetadata', 117 'recipient_id_metadata': 'PropertyMetadata', 118 'require_all': 'str', 119 'require_all_metadata': 'PropertyMetadata', 120 'required': 'str', 121 'required_metadata': 'PropertyMetadata', 122 'require_initial_on_shared_change': 'str', 123 'require_initial_on_shared_change_metadata': 'PropertyMetadata', 124 'round_decimal_places': 'str', 125 'round_decimal_places_metadata': 'PropertyMetadata', 126 'sender_required': 'str', 127 'sender_required_metadata': 'PropertyMetadata', 128 'shared': 'str', 129 'shared_metadata': 'PropertyMetadata', 130 'share_to_recipients': 'str', 131 'share_to_recipients_metadata': 'PropertyMetadata', 132 'smart_contract_information': 'SmartContractInformation', 133 'source': 'str', 134 'status': 'str', 135 'status_metadata': 'PropertyMetadata', 136 'tab_fully_qualified_path': 'str', 137 'tab_group_labels': 'list[str]', 138 'tab_group_labels_metadata': 'PropertyMetadata', 139 'tab_id': 'str', 140 'tab_id_metadata': 'PropertyMetadata', 141 'tab_label': 'str', 142 'tab_label_metadata': 'PropertyMetadata', 143 'tab_order': 'str', 144 'tab_order_metadata': 'PropertyMetadata', 145 'tab_type': 'str', 146 'tab_type_metadata': 'PropertyMetadata', 147 'template_locked': 'str', 148 'template_locked_metadata': 'PropertyMetadata', 149 'template_required': 'str', 150 'template_required_metadata': 'PropertyMetadata', 151 'tooltip': 'str', 152 'tool_tip_metadata': 'PropertyMetadata', 153 'underline': 'str', 154 'underline_metadata': 'PropertyMetadata', 155 'validation_message': 'str', 156 'validation_message_metadata': 'PropertyMetadata', 157 'validation_pattern': 'str', 158 'validation_pattern_metadata': 'PropertyMetadata', 159 'value': 'str', 160 'value_metadata': 'PropertyMetadata', 161 'warning_details': 'ErrorDetails', 162 'width': 'str', 163 'width_metadata': 'PropertyMetadata', 164 'x_position': 'str', 165 'x_position_metadata': 'PropertyMetadata', 166 'y_position': 'str', 167 'y_position_metadata': 'PropertyMetadata' 168 } 169 170 attribute_map = { 171 'agreement_attribute': 'agreementAttribute', 172 'agreement_attribute_locked': 'agreementAttributeLocked', 173 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 174 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 175 'anchor_case_sensitive': 'anchorCaseSensitive', 176 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 177 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 178 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 179 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 180 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 181 'anchor_match_whole_word': 'anchorMatchWholeWord', 182 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 183 'anchor_string': 'anchorString', 184 'anchor_string_metadata': 'anchorStringMetadata', 185 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 186 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 187 'anchor_units': 'anchorUnits', 188 'anchor_units_metadata': 'anchorUnitsMetadata', 189 'anchor_x_offset': 'anchorXOffset', 190 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 191 'anchor_y_offset': 'anchorYOffset', 192 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 193 'bold': 'bold', 194 'bold_metadata': 'boldMetadata', 195 'caption': 'caption', 196 'caption_metadata': 'captionMetadata', 197 'conceal_value_on_document': 'concealValueOnDocument', 198 'conceal_value_on_document_metadata': 'concealValueOnDocumentMetadata', 199 'conditional_parent_label': 'conditionalParentLabel', 200 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 201 'conditional_parent_value': 'conditionalParentValue', 202 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 203 'connected_object_details': 'connectedObjectDetails', 204 'custom_tab_id': 'customTabId', 205 'custom_tab_id_metadata': 'customTabIdMetadata', 206 'disable_auto_size': 'disableAutoSize', 207 'disable_auto_size_metadata': 'disableAutoSizeMetadata', 208 'document_id': 'documentId', 209 'document_id_metadata': 'documentIdMetadata', 210 'error_details': 'errorDetails', 211 'extension_data': 'extensionData', 212 'font': 'font', 213 'font_color': 'fontColor', 214 'font_color_metadata': 'fontColorMetadata', 215 'font_metadata': 'fontMetadata', 216 'font_size': 'fontSize', 217 'font_size_metadata': 'fontSizeMetadata', 218 'form_order': 'formOrder', 219 'form_order_metadata': 'formOrderMetadata', 220 'form_page_label': 'formPageLabel', 221 'form_page_label_metadata': 'formPageLabelMetadata', 222 'form_page_number': 'formPageNumber', 223 'form_page_number_metadata': 'formPageNumberMetadata', 224 'formula': 'formula', 225 'formula_metadata': 'formulaMetadata', 226 'height': 'height', 227 'height_metadata': 'heightMetadata', 228 'hidden': 'hidden', 229 'hidden_metadata': 'hiddenMetadata', 230 'is_payment_amount': 'isPaymentAmount', 231 'is_payment_amount_metadata': 'isPaymentAmountMetadata', 232 'italic': 'italic', 233 'italic_metadata': 'italicMetadata', 234 'locale_policy': 'localePolicy', 235 'locked': 'locked', 236 'locked_metadata': 'lockedMetadata', 237 'max_length': 'maxLength', 238 'max_length_metadata': 'maxLengthMetadata', 239 'merge_field': 'mergeField', 240 'merge_field_xml': 'mergeFieldXml', 241 'name': 'name', 242 'name_metadata': 'nameMetadata', 243 'original_value': 'originalValue', 244 'original_value_metadata': 'originalValueMetadata', 245 'page_number': 'pageNumber', 246 'page_number_metadata': 'pageNumberMetadata', 247 'payment_details': 'paymentDetails', 248 'recipient_id': 'recipientId', 249 'recipient_id_guid': 'recipientIdGuid', 250 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 251 'recipient_id_metadata': 'recipientIdMetadata', 252 'require_all': 'requireAll', 253 'require_all_metadata': 'requireAllMetadata', 254 'required': 'required', 255 'required_metadata': 'requiredMetadata', 256 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 257 'require_initial_on_shared_change_metadata': 'requireInitialOnSharedChangeMetadata', 258 'round_decimal_places': 'roundDecimalPlaces', 259 'round_decimal_places_metadata': 'roundDecimalPlacesMetadata', 260 'sender_required': 'senderRequired', 261 'sender_required_metadata': 'senderRequiredMetadata', 262 'shared': 'shared', 263 'shared_metadata': 'sharedMetadata', 264 'share_to_recipients': 'shareToRecipients', 265 'share_to_recipients_metadata': 'shareToRecipientsMetadata', 266 'smart_contract_information': 'smartContractInformation', 267 'source': 'source', 268 'status': 'status', 269 'status_metadata': 'statusMetadata', 270 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 271 'tab_group_labels': 'tabGroupLabels', 272 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 273 'tab_id': 'tabId', 274 'tab_id_metadata': 'tabIdMetadata', 275 'tab_label': 'tabLabel', 276 'tab_label_metadata': 'tabLabelMetadata', 277 'tab_order': 'tabOrder', 278 'tab_order_metadata': 'tabOrderMetadata', 279 'tab_type': 'tabType', 280 'tab_type_metadata': 'tabTypeMetadata', 281 'template_locked': 'templateLocked', 282 'template_locked_metadata': 'templateLockedMetadata', 283 'template_required': 'templateRequired', 284 'template_required_metadata': 'templateRequiredMetadata', 285 'tooltip': 'tooltip', 286 'tool_tip_metadata': 'toolTipMetadata', 287 'underline': 'underline', 288 'underline_metadata': 'underlineMetadata', 289 'validation_message': 'validationMessage', 290 'validation_message_metadata': 'validationMessageMetadata', 291 'validation_pattern': 'validationPattern', 292 'validation_pattern_metadata': 'validationPatternMetadata', 293 'value': 'value', 294 'value_metadata': 'valueMetadata', 295 'warning_details': 'warningDetails', 296 'width': 'width', 297 'width_metadata': 'widthMetadata', 298 'x_position': 'xPosition', 299 'x_position_metadata': 'xPositionMetadata', 300 'y_position': 'yPosition', 301 'y_position_metadata': 'yPositionMetadata' 302 } 303 304 def __init__(self, _configuration=None, **kwargs): # noqa: E501 305 """FormulaTab - a model defined in Swagger""" # noqa: E501 306 if _configuration is None: 307 _configuration = Configuration() 308 self._configuration = _configuration 309 310 self._agreement_attribute = None 311 self._agreement_attribute_locked = None 312 self._anchor_allow_white_space_in_characters = None 313 self._anchor_allow_white_space_in_characters_metadata = None 314 self._anchor_case_sensitive = None 315 self._anchor_case_sensitive_metadata = None 316 self._anchor_horizontal_alignment = None 317 self._anchor_horizontal_alignment_metadata = None 318 self._anchor_ignore_if_not_present = None 319 self._anchor_ignore_if_not_present_metadata = None 320 self._anchor_match_whole_word = None 321 self._anchor_match_whole_word_metadata = None 322 self._anchor_string = None 323 self._anchor_string_metadata = None 324 self._anchor_tab_processor_version = None 325 self._anchor_tab_processor_version_metadata = None 326 self._anchor_units = None 327 self._anchor_units_metadata = None 328 self._anchor_x_offset = None 329 self._anchor_x_offset_metadata = None 330 self._anchor_y_offset = None 331 self._anchor_y_offset_metadata = None 332 self._bold = None 333 self._bold_metadata = None 334 self._caption = None 335 self._caption_metadata = None 336 self._conceal_value_on_document = None 337 self._conceal_value_on_document_metadata = None 338 self._conditional_parent_label = None 339 self._conditional_parent_label_metadata = None 340 self._conditional_parent_value = None 341 self._conditional_parent_value_metadata = None 342 self._connected_object_details = None 343 self._custom_tab_id = None 344 self._custom_tab_id_metadata = None 345 self._disable_auto_size = None 346 self._disable_auto_size_metadata = None 347 self._document_id = None 348 self._document_id_metadata = None 349 self._error_details = None 350 self._extension_data = None 351 self._font = None 352 self._font_color = None 353 self._font_color_metadata = None 354 self._font_metadata = None 355 self._font_size = None 356 self._font_size_metadata = None 357 self._form_order = None 358 self._form_order_metadata = None 359 self._form_page_label = None 360 self._form_page_label_metadata = None 361 self._form_page_number = None 362 self._form_page_number_metadata = None 363 self._formula = None 364 self._formula_metadata = None 365 self._height = None 366 self._height_metadata = None 367 self._hidden = None 368 self._hidden_metadata = None 369 self._is_payment_amount = None 370 self._is_payment_amount_metadata = None 371 self._italic = None 372 self._italic_metadata = None 373 self._locale_policy = None 374 self._locked = None 375 self._locked_metadata = None 376 self._max_length = None 377 self._max_length_metadata = None 378 self._merge_field = None 379 self._merge_field_xml = None 380 self._name = None 381 self._name_metadata = None 382 self._original_value = None 383 self._original_value_metadata = None 384 self._page_number = None 385 self._page_number_metadata = None 386 self._payment_details = None 387 self._recipient_id = None 388 self._recipient_id_guid = None 389 self._recipient_id_guid_metadata = None 390 self._recipient_id_metadata = None 391 self._require_all = None 392 self._require_all_metadata = None 393 self._required = None 394 self._required_metadata = None 395 self._require_initial_on_shared_change = None 396 self._require_initial_on_shared_change_metadata = None 397 self._round_decimal_places = None 398 self._round_decimal_places_metadata = None 399 self._sender_required = None 400 self._sender_required_metadata = None 401 self._shared = None 402 self._shared_metadata = None 403 self._share_to_recipients = None 404 self._share_to_recipients_metadata = None 405 self._smart_contract_information = None 406 self._source = None 407 self._status = None 408 self._status_metadata = None 409 self._tab_fully_qualified_path = None 410 self._tab_group_labels = None 411 self._tab_group_labels_metadata = None 412 self._tab_id = None 413 self._tab_id_metadata = None 414 self._tab_label = None 415 self._tab_label_metadata = None 416 self._tab_order = None 417 self._tab_order_metadata = None 418 self._tab_type = None 419 self._tab_type_metadata = None 420 self._template_locked = None 421 self._template_locked_metadata = None 422 self._template_required = None 423 self._template_required_metadata = None 424 self._tooltip = None 425 self._tool_tip_metadata = None 426 self._underline = None 427 self._underline_metadata = None 428 self._validation_message = None 429 self._validation_message_metadata = None 430 self._validation_pattern = None 431 self._validation_pattern_metadata = None 432 self._value = None 433 self._value_metadata = None 434 self._warning_details = None 435 self._width = None 436 self._width_metadata = None 437 self._x_position = None 438 self._x_position_metadata = None 439 self._y_position = None 440 self._y_position_metadata = None 441 self.discriminator = None 442 443 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 444 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 445 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 446 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 447 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 448 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 449 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 450 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 451 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 452 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 453 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 454 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 455 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 456 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 457 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 458 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 459 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 460 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 461 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 462 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 463 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 464 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 465 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 466 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 467 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 468 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 469 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 470 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 471 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 472 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 473 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 474 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 475 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 476 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 477 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 478 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 479 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 480 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 481 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 482 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 483 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 484 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 485 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 486 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 487 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 488 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 489 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 490 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 491 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 492 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 493 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 494 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 495 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 496 setattr(self, "_{}".format('formula'), kwargs.get('formula', None)) 497 setattr(self, "_{}".format('formula_metadata'), kwargs.get('formula_metadata', None)) 498 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 499 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 500 setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None)) 501 setattr(self, "_{}".format('hidden_metadata'), kwargs.get('hidden_metadata', None)) 502 setattr(self, "_{}".format('is_payment_amount'), kwargs.get('is_payment_amount', None)) 503 setattr(self, "_{}".format('is_payment_amount_metadata'), kwargs.get('is_payment_amount_metadata', None)) 504 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 505 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 506 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 507 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 508 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 509 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 510 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 511 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 512 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 513 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 514 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 515 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 516 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 517 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 518 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 519 setattr(self, "_{}".format('payment_details'), kwargs.get('payment_details', None)) 520 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 521 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 522 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 523 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 524 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 525 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 526 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 527 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 528 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 529 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 530 setattr(self, "_{}".format('round_decimal_places'), kwargs.get('round_decimal_places', None)) 531 setattr(self, "_{}".format('round_decimal_places_metadata'), kwargs.get('round_decimal_places_metadata', None)) 532 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 533 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 534 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 535 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 536 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 537 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 538 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 539 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 540 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 541 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 542 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 543 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 544 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 545 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 546 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 547 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 548 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 549 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 550 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 551 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 552 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 553 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 554 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 555 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 556 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 557 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 558 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 559 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 560 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 561 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 562 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 563 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 564 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 565 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 566 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 567 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 568 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 569 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 570 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 571 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 572 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 573 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None)) 574 575 @property 576 def agreement_attribute(self): 577 """Gets the agreement_attribute of this FormulaTab. # noqa: E501 578 579 # noqa: E501 580 581 :return: The agreement_attribute of this FormulaTab. # noqa: E501 582 :rtype: str 583 """ 584 return self._agreement_attribute 585 586 @agreement_attribute.setter 587 def agreement_attribute(self, agreement_attribute): 588 """Sets the agreement_attribute of this FormulaTab. 589 590 # noqa: E501 591 592 :param agreement_attribute: The agreement_attribute of this FormulaTab. # noqa: E501 593 :type: str 594 """ 595 596 self._agreement_attribute = agreement_attribute 597 598 @property 599 def agreement_attribute_locked(self): 600 """Gets the agreement_attribute_locked of this FormulaTab. # noqa: E501 601 602 # noqa: E501 603 604 :return: The agreement_attribute_locked of this FormulaTab. # noqa: E501 605 :rtype: str 606 """ 607 return self._agreement_attribute_locked 608 609 @agreement_attribute_locked.setter 610 def agreement_attribute_locked(self, agreement_attribute_locked): 611 """Sets the agreement_attribute_locked of this FormulaTab. 612 613 # noqa: E501 614 615 :param agreement_attribute_locked: The agreement_attribute_locked of this FormulaTab. # noqa: E501 616 :type: str 617 """ 618 619 self._agreement_attribute_locked = agreement_attribute_locked 620 621 @property 622 def anchor_allow_white_space_in_characters(self): 623 """Gets the anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 624 625 # noqa: E501 626 627 :return: The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 628 :rtype: str 629 """ 630 return self._anchor_allow_white_space_in_characters 631 632 @anchor_allow_white_space_in_characters.setter 633 def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): 634 """Sets the anchor_allow_white_space_in_characters of this FormulaTab. 635 636 # noqa: E501 637 638 :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 639 :type: str 640 """ 641 642 self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters 643 644 @property 645 def anchor_allow_white_space_in_characters_metadata(self): 646 """Gets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 647 648 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 649 650 :return: The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 651 :rtype: PropertyMetadata 652 """ 653 return self._anchor_allow_white_space_in_characters_metadata 654 655 @anchor_allow_white_space_in_characters_metadata.setter 656 def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): 657 """Sets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. 658 659 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 660 661 :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 662 :type: PropertyMetadata 663 """ 664 665 self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata 666 667 @property 668 def anchor_case_sensitive(self): 669 """Gets the anchor_case_sensitive of this FormulaTab. # noqa: E501 670 671 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 672 673 :return: The anchor_case_sensitive of this FormulaTab. # noqa: E501 674 :rtype: str 675 """ 676 return self._anchor_case_sensitive 677 678 @anchor_case_sensitive.setter 679 def anchor_case_sensitive(self, anchor_case_sensitive): 680 """Sets the anchor_case_sensitive of this FormulaTab. 681 682 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 683 684 :param anchor_case_sensitive: The anchor_case_sensitive of this FormulaTab. # noqa: E501 685 :type: str 686 """ 687 688 self._anchor_case_sensitive = anchor_case_sensitive 689 690 @property 691 def anchor_case_sensitive_metadata(self): 692 """Gets the anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 693 694 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 695 696 :return: The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 697 :rtype: PropertyMetadata 698 """ 699 return self._anchor_case_sensitive_metadata 700 701 @anchor_case_sensitive_metadata.setter 702 def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): 703 """Sets the anchor_case_sensitive_metadata of this FormulaTab. 704 705 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 706 707 :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 708 :type: PropertyMetadata 709 """ 710 711 self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata 712 713 @property 714 def anchor_horizontal_alignment(self): 715 """Gets the anchor_horizontal_alignment of this FormulaTab. # noqa: E501 716 717 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 718 719 :return: The anchor_horizontal_alignment of this FormulaTab. # noqa: E501 720 :rtype: str 721 """ 722 return self._anchor_horizontal_alignment 723 724 @anchor_horizontal_alignment.setter 725 def anchor_horizontal_alignment(self, anchor_horizontal_alignment): 726 """Sets the anchor_horizontal_alignment of this FormulaTab. 727 728 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 729 730 :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this FormulaTab. # noqa: E501 731 :type: str 732 """ 733 734 self._anchor_horizontal_alignment = anchor_horizontal_alignment 735 736 @property 737 def anchor_horizontal_alignment_metadata(self): 738 """Gets the anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 739 740 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 741 742 :return: The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 743 :rtype: PropertyMetadata 744 """ 745 return self._anchor_horizontal_alignment_metadata 746 747 @anchor_horizontal_alignment_metadata.setter 748 def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): 749 """Sets the anchor_horizontal_alignment_metadata of this FormulaTab. 750 751 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 752 753 :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 754 :type: PropertyMetadata 755 """ 756 757 self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata 758 759 @property 760 def anchor_ignore_if_not_present(self): 761 """Gets the anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 762 763 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 764 765 :return: The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 766 :rtype: str 767 """ 768 return self._anchor_ignore_if_not_present 769 770 @anchor_ignore_if_not_present.setter 771 def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): 772 """Sets the anchor_ignore_if_not_present of this FormulaTab. 773 774 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 775 776 :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 777 :type: str 778 """ 779 780 self._anchor_ignore_if_not_present = anchor_ignore_if_not_present 781 782 @property 783 def anchor_ignore_if_not_present_metadata(self): 784 """Gets the anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 785 786 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 787 788 :return: The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 789 :rtype: PropertyMetadata 790 """ 791 return self._anchor_ignore_if_not_present_metadata 792 793 @anchor_ignore_if_not_present_metadata.setter 794 def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): 795 """Sets the anchor_ignore_if_not_present_metadata of this FormulaTab. 796 797 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 798 799 :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 800 :type: PropertyMetadata 801 """ 802 803 self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata 804 805 @property 806 def anchor_match_whole_word(self): 807 """Gets the anchor_match_whole_word of this FormulaTab. # noqa: E501 808 809 When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. # noqa: E501 810 811 :return: The anchor_match_whole_word of this FormulaTab. # noqa: E501 812 :rtype: str 813 """ 814 return self._anchor_match_whole_word 815 816 @anchor_match_whole_word.setter 817 def anchor_match_whole_word(self, anchor_match_whole_word): 818 """Sets the anchor_match_whole_word of this FormulaTab. 819 820 When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**. # noqa: E501 821 822 :param anchor_match_whole_word: The anchor_match_whole_word of this FormulaTab. # noqa: E501 823 :type: str 824 """ 825 826 self._anchor_match_whole_word = anchor_match_whole_word 827 828 @property 829 def anchor_match_whole_word_metadata(self): 830 """Gets the anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 831 832 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 833 834 :return: The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 835 :rtype: PropertyMetadata 836 """ 837 return self._anchor_match_whole_word_metadata 838 839 @anchor_match_whole_word_metadata.setter 840 def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): 841 """Sets the anchor_match_whole_word_metadata of this FormulaTab. 842 843 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 844 845 :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 846 :type: PropertyMetadata 847 """ 848 849 self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata 850 851 @property 852 def anchor_string(self): 853 """Gets the anchor_string of this FormulaTab. # noqa: E501 854 855 Anchor text information for a radio button. # noqa: E501 856 857 :return: The anchor_string of this FormulaTab. # noqa: E501 858 :rtype: str 859 """ 860 return self._anchor_string 861 862 @anchor_string.setter 863 def anchor_string(self, anchor_string): 864 """Sets the anchor_string of this FormulaTab. 865 866 Anchor text information for a radio button. # noqa: E501 867 868 :param anchor_string: The anchor_string of this FormulaTab. # noqa: E501 869 :type: str 870 """ 871 872 self._anchor_string = anchor_string 873 874 @property 875 def anchor_string_metadata(self): 876 """Gets the anchor_string_metadata of this FormulaTab. # noqa: E501 877 878 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 879 880 :return: The anchor_string_metadata of this FormulaTab. # noqa: E501 881 :rtype: PropertyMetadata 882 """ 883 return self._anchor_string_metadata 884 885 @anchor_string_metadata.setter 886 def anchor_string_metadata(self, anchor_string_metadata): 887 """Sets the anchor_string_metadata of this FormulaTab. 888 889 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 890 891 :param anchor_string_metadata: The anchor_string_metadata of this FormulaTab. # noqa: E501 892 :type: PropertyMetadata 893 """ 894 895 self._anchor_string_metadata = anchor_string_metadata 896 897 @property 898 def anchor_tab_processor_version(self): 899 """Gets the anchor_tab_processor_version of this FormulaTab. # noqa: E501 900 901 # noqa: E501 902 903 :return: The anchor_tab_processor_version of this FormulaTab. # noqa: E501 904 :rtype: str 905 """ 906 return self._anchor_tab_processor_version 907 908 @anchor_tab_processor_version.setter 909 def anchor_tab_processor_version(self, anchor_tab_processor_version): 910 """Sets the anchor_tab_processor_version of this FormulaTab. 911 912 # noqa: E501 913 914 :param anchor_tab_processor_version: The anchor_tab_processor_version of this FormulaTab. # noqa: E501 915 :type: str 916 """ 917 918 self._anchor_tab_processor_version = anchor_tab_processor_version 919 920 @property 921 def anchor_tab_processor_version_metadata(self): 922 """Gets the anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 923 924 Reserved for DocuSign. # noqa: E501 925 926 :return: The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 927 :rtype: PropertyMetadata 928 """ 929 return self._anchor_tab_processor_version_metadata 930 931 @anchor_tab_processor_version_metadata.setter 932 def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): 933 """Sets the anchor_tab_processor_version_metadata of this FormulaTab. 934 935 Reserved for DocuSign. # noqa: E501 936 937 :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 938 :type: PropertyMetadata 939 """ 940 941 self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata 942 943 @property 944 def anchor_units(self): 945 """Gets the anchor_units of this FormulaTab. # noqa: E501 946 947 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 948 949 :return: The anchor_units of this FormulaTab. # noqa: E501 950 :rtype: str 951 """ 952 return self._anchor_units 953 954 @anchor_units.setter 955 def anchor_units(self, anchor_units): 956 """Sets the anchor_units of this FormulaTab. 957 958 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 959 960 :param anchor_units: The anchor_units of this FormulaTab. # noqa: E501 961 :type: str 962 """ 963 964 self._anchor_units = anchor_units 965 966 @property 967 def anchor_units_metadata(self): 968 """Gets the anchor_units_metadata of this FormulaTab. # noqa: E501 969 970 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 971 972 :return: The anchor_units_metadata of this FormulaTab. # noqa: E501 973 :rtype: PropertyMetadata 974 """ 975 return self._anchor_units_metadata 976 977 @anchor_units_metadata.setter 978 def anchor_units_metadata(self, anchor_units_metadata): 979 """Sets the anchor_units_metadata of this FormulaTab. 980 981 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 982 983 :param anchor_units_metadata: The anchor_units_metadata of this FormulaTab. # noqa: E501 984 :type: PropertyMetadata 985 """ 986 987 self._anchor_units_metadata = anchor_units_metadata 988 989 @property 990 def anchor_x_offset(self): 991 """Gets the anchor_x_offset of this FormulaTab. # noqa: E501 992 993 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 994 995 :return: The anchor_x_offset of this FormulaTab. # noqa: E501 996 :rtype: str 997 """ 998 return self._anchor_x_offset 999 1000 @anchor_x_offset.setter 1001 def anchor_x_offset(self, anchor_x_offset): 1002 """Sets the anchor_x_offset of this FormulaTab. 1003 1004 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1005 1006 :param anchor_x_offset: The anchor_x_offset of this FormulaTab. # noqa: E501 1007 :type: str 1008 """ 1009 1010 self._anchor_x_offset = anchor_x_offset 1011 1012 @property 1013 def anchor_x_offset_metadata(self): 1014 """Gets the anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1015 1016 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1017 1018 :return: The anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1019 :rtype: PropertyMetadata 1020 """ 1021 return self._anchor_x_offset_metadata 1022 1023 @anchor_x_offset_metadata.setter 1024 def anchor_x_offset_metadata(self, anchor_x_offset_metadata): 1025 """Sets the anchor_x_offset_metadata of this FormulaTab. 1026 1027 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1028 1029 :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1030 :type: PropertyMetadata 1031 """ 1032 1033 self._anchor_x_offset_metadata = anchor_x_offset_metadata 1034 1035 @property 1036 def anchor_y_offset(self): 1037 """Gets the anchor_y_offset of this FormulaTab. # noqa: E501 1038 1039 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1040 1041 :return: The anchor_y_offset of this FormulaTab. # noqa: E501 1042 :rtype: str 1043 """ 1044 return self._anchor_y_offset 1045 1046 @anchor_y_offset.setter 1047 def anchor_y_offset(self, anchor_y_offset): 1048 """Sets the anchor_y_offset of this FormulaTab. 1049 1050 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1051 1052 :param anchor_y_offset: The anchor_y_offset of this FormulaTab. # noqa: E501 1053 :type: str 1054 """ 1055 1056 self._anchor_y_offset = anchor_y_offset 1057 1058 @property 1059 def anchor_y_offset_metadata(self): 1060 """Gets the anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1061 1062 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1063 1064 :return: The anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1065 :rtype: PropertyMetadata 1066 """ 1067 return self._anchor_y_offset_metadata 1068 1069 @anchor_y_offset_metadata.setter 1070 def anchor_y_offset_metadata(self, anchor_y_offset_metadata): 1071 """Sets the anchor_y_offset_metadata of this FormulaTab. 1072 1073 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1074 1075 :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1076 :type: PropertyMetadata 1077 """ 1078 1079 self._anchor_y_offset_metadata = anchor_y_offset_metadata 1080 1081 @property 1082 def bold(self): 1083 """Gets the bold of this FormulaTab. # noqa: E501 1084 1085 When set to **true**, the information in the tab is bold. # noqa: E501 1086 1087 :return: The bold of this FormulaTab. # noqa: E501 1088 :rtype: str 1089 """ 1090 return self._bold 1091 1092 @bold.setter 1093 def bold(self, bold): 1094 """Sets the bold of this FormulaTab. 1095 1096 When set to **true**, the information in the tab is bold. # noqa: E501 1097 1098 :param bold: The bold of this FormulaTab. # noqa: E501 1099 :type: str 1100 """ 1101 1102 self._bold = bold 1103 1104 @property 1105 def bold_metadata(self): 1106 """Gets the bold_metadata of this FormulaTab. # noqa: E501 1107 1108 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1109 1110 :return: The bold_metadata of this FormulaTab. # noqa: E501 1111 :rtype: PropertyMetadata 1112 """ 1113 return self._bold_metadata 1114 1115 @bold_metadata.setter 1116 def bold_metadata(self, bold_metadata): 1117 """Sets the bold_metadata of this FormulaTab. 1118 1119 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1120 1121 :param bold_metadata: The bold_metadata of this FormulaTab. # noqa: E501 1122 :type: PropertyMetadata 1123 """ 1124 1125 self._bold_metadata = bold_metadata 1126 1127 @property 1128 def caption(self): 1129 """Gets the caption of this FormulaTab. # noqa: E501 1130 1131 # noqa: E501 1132 1133 :return: The caption of this FormulaTab. # noqa: E501 1134 :rtype: str 1135 """ 1136 return self._caption 1137 1138 @caption.setter 1139 def caption(self, caption): 1140 """Sets the caption of this FormulaTab. 1141 1142 # noqa: E501 1143 1144 :param caption: The caption of this FormulaTab. # noqa: E501 1145 :type: str 1146 """ 1147 1148 self._caption = caption 1149 1150 @property 1151 def caption_metadata(self): 1152 """Gets the caption_metadata of this FormulaTab. # noqa: E501 1153 1154 # noqa: E501 1155 1156 :return: The caption_metadata of this FormulaTab. # noqa: E501 1157 :rtype: PropertyMetadata 1158 """ 1159 return self._caption_metadata 1160 1161 @caption_metadata.setter 1162 def caption_metadata(self, caption_metadata): 1163 """Sets the caption_metadata of this FormulaTab. 1164 1165 # noqa: E501 1166 1167 :param caption_metadata: The caption_metadata of this FormulaTab. # noqa: E501 1168 :type: PropertyMetadata 1169 """ 1170 1171 self._caption_metadata = caption_metadata 1172 1173 @property 1174 def conceal_value_on_document(self): 1175 """Gets the conceal_value_on_document of this FormulaTab. # noqa: E501 1176 1177 When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501 1178 1179 :return: The conceal_value_on_document of this FormulaTab. # noqa: E501 1180 :rtype: str 1181 """ 1182 return self._conceal_value_on_document 1183 1184 @conceal_value_on_document.setter 1185 def conceal_value_on_document(self, conceal_value_on_document): 1186 """Sets the conceal_value_on_document of this FormulaTab. 1187 1188 When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501 1189 1190 :param conceal_value_on_document: The conceal_value_on_document of this FormulaTab. # noqa: E501 1191 :type: str 1192 """ 1193 1194 self._conceal_value_on_document = conceal_value_on_document 1195 1196 @property 1197 def conceal_value_on_document_metadata(self): 1198 """Gets the conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1199 1200 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1201 1202 :return: The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1203 :rtype: PropertyMetadata 1204 """ 1205 return self._conceal_value_on_document_metadata 1206 1207 @conceal_value_on_document_metadata.setter 1208 def conceal_value_on_document_metadata(self, conceal_value_on_document_metadata): 1209 """Sets the conceal_value_on_document_metadata of this FormulaTab. 1210 1211 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1212 1213 :param conceal_value_on_document_metadata: The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1214 :type: PropertyMetadata 1215 """ 1216 1217 self._conceal_value_on_document_metadata = conceal_value_on_document_metadata 1218 1219 @property 1220 def conditional_parent_label(self): 1221 """Gets the conditional_parent_label of this FormulaTab. # noqa: E501 1222 1223 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1224 1225 :return: The conditional_parent_label of this FormulaTab. # noqa: E501 1226 :rtype: str 1227 """ 1228 return self._conditional_parent_label 1229 1230 @conditional_parent_label.setter 1231 def conditional_parent_label(self, conditional_parent_label): 1232 """Sets the conditional_parent_label of this FormulaTab. 1233 1234 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1235 1236 :param conditional_parent_label: The conditional_parent_label of this FormulaTab. # noqa: E501 1237 :type: str 1238 """ 1239 1240 self._conditional_parent_label = conditional_parent_label 1241 1242 @property 1243 def conditional_parent_label_metadata(self): 1244 """Gets the conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1245 1246 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1247 1248 :return: The conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1249 :rtype: PropertyMetadata 1250 """ 1251 return self._conditional_parent_label_metadata 1252 1253 @conditional_parent_label_metadata.setter 1254 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 1255 """Sets the conditional_parent_label_metadata of this FormulaTab. 1256 1257 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1258 1259 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1260 :type: PropertyMetadata 1261 """ 1262 1263 self._conditional_parent_label_metadata = conditional_parent_label_metadata 1264 1265 @property 1266 def conditional_parent_value(self): 1267 """Gets the conditional_parent_value of this FormulaTab. # noqa: E501 1268 1269 For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 1270 1271 :return: The conditional_parent_value of this FormulaTab. # noqa: E501 1272 :rtype: str 1273 """ 1274 return self._conditional_parent_value 1275 1276 @conditional_parent_value.setter 1277 def conditional_parent_value(self, conditional_parent_value): 1278 """Sets the conditional_parent_value of this FormulaTab. 1279 1280 For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 1281 1282 :param conditional_parent_value: The conditional_parent_value of this FormulaTab. # noqa: E501 1283 :type: str 1284 """ 1285 1286 self._conditional_parent_value = conditional_parent_value 1287 1288 @property 1289 def conditional_parent_value_metadata(self): 1290 """Gets the conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1291 1292 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1293 1294 :return: The conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1295 :rtype: PropertyMetadata 1296 """ 1297 return self._conditional_parent_value_metadata 1298 1299 @conditional_parent_value_metadata.setter 1300 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 1301 """Sets the conditional_parent_value_metadata of this FormulaTab. 1302 1303 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1304 1305 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1306 :type: PropertyMetadata 1307 """ 1308 1309 self._conditional_parent_value_metadata = conditional_parent_value_metadata 1310 1311 @property 1312 def connected_object_details(self): 1313 """Gets the connected_object_details of this FormulaTab. # noqa: E501 1314 1315 # noqa: E501 1316 1317 :return: The connected_object_details of this FormulaTab. # noqa: E501 1318 :rtype: ConnectedObjectDetails 1319 """ 1320 return self._connected_object_details 1321 1322 @connected_object_details.setter 1323 def connected_object_details(self, connected_object_details): 1324 """Sets the connected_object_details of this FormulaTab. 1325 1326 # noqa: E501 1327 1328 :param connected_object_details: The connected_object_details of this FormulaTab. # noqa: E501 1329 :type: ConnectedObjectDetails 1330 """ 1331 1332 self._connected_object_details = connected_object_details 1333 1334 @property 1335 def custom_tab_id(self): 1336 """Gets the custom_tab_id of this FormulaTab. # noqa: E501 1337 1338 The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501 1339 1340 :return: The custom_tab_id of this FormulaTab. # noqa: E501 1341 :rtype: str 1342 """ 1343 return self._custom_tab_id 1344 1345 @custom_tab_id.setter 1346 def custom_tab_id(self, custom_tab_id): 1347 """Sets the custom_tab_id of this FormulaTab. 1348 1349 The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501 1350 1351 :param custom_tab_id: The custom_tab_id of this FormulaTab. # noqa: E501 1352 :type: str 1353 """ 1354 1355 self._custom_tab_id = custom_tab_id 1356 1357 @property 1358 def custom_tab_id_metadata(self): 1359 """Gets the custom_tab_id_metadata of this FormulaTab. # noqa: E501 1360 1361 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1362 1363 :return: The custom_tab_id_metadata of this FormulaTab. # noqa: E501 1364 :rtype: PropertyMetadata 1365 """ 1366 return self._custom_tab_id_metadata 1367 1368 @custom_tab_id_metadata.setter 1369 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1370 """Sets the custom_tab_id_metadata of this FormulaTab. 1371 1372 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1373 1374 :param custom_tab_id_metadata: The custom_tab_id_metadata of this FormulaTab. # noqa: E501 1375 :type: PropertyMetadata 1376 """ 1377 1378 self._custom_tab_id_metadata = custom_tab_id_metadata 1379 1380 @property 1381 def disable_auto_size(self): 1382 """Gets the disable_auto_size of this FormulaTab. # noqa: E501 1383 1384 When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501 1385 1386 :return: The disable_auto_size of this FormulaTab. # noqa: E501 1387 :rtype: str 1388 """ 1389 return self._disable_auto_size 1390 1391 @disable_auto_size.setter 1392 def disable_auto_size(self, disable_auto_size): 1393 """Sets the disable_auto_size of this FormulaTab. 1394 1395 When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501 1396 1397 :param disable_auto_size: The disable_auto_size of this FormulaTab. # noqa: E501 1398 :type: str 1399 """ 1400 1401 self._disable_auto_size = disable_auto_size 1402 1403 @property 1404 def disable_auto_size_metadata(self): 1405 """Gets the disable_auto_size_metadata of this FormulaTab. # noqa: E501 1406 1407 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1408 1409 :return: The disable_auto_size_metadata of this FormulaTab. # noqa: E501 1410 :rtype: PropertyMetadata 1411 """ 1412 return self._disable_auto_size_metadata 1413 1414 @disable_auto_size_metadata.setter 1415 def disable_auto_size_metadata(self, disable_auto_size_metadata): 1416 """Sets the disable_auto_size_metadata of this FormulaTab. 1417 1418 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1419 1420 :param disable_auto_size_metadata: The disable_auto_size_metadata of this FormulaTab. # noqa: E501 1421 :type: PropertyMetadata 1422 """ 1423 1424 self._disable_auto_size_metadata = disable_auto_size_metadata 1425 1426 @property 1427 def document_id(self): 1428 """Gets the document_id of this FormulaTab. # noqa: E501 1429 1430 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1431 1432 :return: The document_id of this FormulaTab. # noqa: E501 1433 :rtype: str 1434 """ 1435 return self._document_id 1436 1437 @document_id.setter 1438 def document_id(self, document_id): 1439 """Sets the document_id of this FormulaTab. 1440 1441 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1442 1443 :param document_id: The document_id of this FormulaTab. # noqa: E501 1444 :type: str 1445 """ 1446 1447 self._document_id = document_id 1448 1449 @property 1450 def document_id_metadata(self): 1451 """Gets the document_id_metadata of this FormulaTab. # noqa: E501 1452 1453 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1454 1455 :return: The document_id_metadata of this FormulaTab. # noqa: E501 1456 :rtype: PropertyMetadata 1457 """ 1458 return self._document_id_metadata 1459 1460 @document_id_metadata.setter 1461 def document_id_metadata(self, document_id_metadata): 1462 """Sets the document_id_metadata of this FormulaTab. 1463 1464 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1465 1466 :param document_id_metadata: The document_id_metadata of this FormulaTab. # noqa: E501 1467 :type: PropertyMetadata 1468 """ 1469 1470 self._document_id_metadata = document_id_metadata 1471 1472 @property 1473 def error_details(self): 1474 """Gets the error_details of this FormulaTab. # noqa: E501 1475 1476 Array or errors. # noqa: E501 1477 1478 :return: The error_details of this FormulaTab. # noqa: E501 1479 :rtype: ErrorDetails 1480 """ 1481 return self._error_details 1482 1483 @error_details.setter 1484 def error_details(self, error_details): 1485 """Sets the error_details of this FormulaTab. 1486 1487 Array or errors. # noqa: E501 1488 1489 :param error_details: The error_details of this FormulaTab. # noqa: E501 1490 :type: ErrorDetails 1491 """ 1492 1493 self._error_details = error_details 1494 1495 @property 1496 def extension_data(self): 1497 """Gets the extension_data of this FormulaTab. # noqa: E501 1498 1499 # noqa: E501 1500 1501 :return: The extension_data of this FormulaTab. # noqa: E501 1502 :rtype: ExtensionData 1503 """ 1504 return self._extension_data 1505 1506 @extension_data.setter 1507 def extension_data(self, extension_data): 1508 """Sets the extension_data of this FormulaTab. 1509 1510 # noqa: E501 1511 1512 :param extension_data: The extension_data of this FormulaTab. # noqa: E501 1513 :type: ExtensionData 1514 """ 1515 1516 self._extension_data = extension_data 1517 1518 @property 1519 def font(self): 1520 """Gets the font of this FormulaTab. # noqa: E501 1521 1522 The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. # noqa: E501 1523 1524 :return: The font of this FormulaTab. # noqa: E501 1525 :rtype: str 1526 """ 1527 return self._font 1528 1529 @font.setter 1530 def font(self, font): 1531 """Sets the font of this FormulaTab. 1532 1533 The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. # noqa: E501 1534 1535 :param font: The font of this FormulaTab. # noqa: E501 1536 :type: str 1537 """ 1538 1539 self._font = font 1540 1541 @property 1542 def font_color(self): 1543 """Gets the font_color of this FormulaTab. # noqa: E501 1544 1545 The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. # noqa: E501 1546 1547 :return: The font_color of this FormulaTab. # noqa: E501 1548 :rtype: str 1549 """ 1550 return self._font_color 1551 1552 @font_color.setter 1553 def font_color(self, font_color): 1554 """Sets the font_color of this FormulaTab. 1555 1556 The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. # noqa: E501 1557 1558 :param font_color: The font_color of this FormulaTab. # noqa: E501 1559 :type: str 1560 """ 1561 1562 self._font_color = font_color 1563 1564 @property 1565 def font_color_metadata(self): 1566 """Gets the font_color_metadata of this FormulaTab. # noqa: E501 1567 1568 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1569 1570 :return: The font_color_metadata of this FormulaTab. # noqa: E501 1571 :rtype: PropertyMetadata 1572 """ 1573 return self._font_color_metadata 1574 1575 @font_color_metadata.setter 1576 def font_color_metadata(self, font_color_metadata): 1577 """Sets the font_color_metadata of this FormulaTab. 1578 1579 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1580 1581 :param font_color_metadata: The font_color_metadata of this FormulaTab. # noqa: E501 1582 :type: PropertyMetadata 1583 """ 1584 1585 self._font_color_metadata = font_color_metadata 1586 1587 @property 1588 def font_metadata(self): 1589 """Gets the font_metadata of this FormulaTab. # noqa: E501 1590 1591 Metadata that indicates whether the `font` property is editable. # noqa: E501 1592 1593 :return: The font_metadata of this FormulaTab. # noqa: E501 1594 :rtype: PropertyMetadata 1595 """ 1596 return self._font_metadata 1597 1598 @font_metadata.setter 1599 def font_metadata(self, font_metadata): 1600 """Sets the font_metadata of this FormulaTab. 1601 1602 Metadata that indicates whether the `font` property is editable. # noqa: E501 1603 1604 :param font_metadata: The font_metadata of this FormulaTab. # noqa: E501 1605 :type: PropertyMetadata 1606 """ 1607 1608 self._font_metadata = font_metadata 1609 1610 @property 1611 def font_size(self): 1612 """Gets the font_size of this FormulaTab. # noqa: E501 1613 1614 The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. # noqa: E501 1615 1616 :return: The font_size of this FormulaTab. # noqa: E501 1617 :rtype: str 1618 """ 1619 return self._font_size 1620 1621 @font_size.setter 1622 def font_size(self, font_size): 1623 """Sets the font_size of this FormulaTab. 1624 1625 The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. # noqa: E501 1626 1627 :param font_size: The font_size of this FormulaTab. # noqa: E501 1628 :type: str 1629 """ 1630 1631 self._font_size = font_size 1632 1633 @property 1634 def font_size_metadata(self): 1635 """Gets the font_size_metadata of this FormulaTab. # noqa: E501 1636 1637 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1638 1639 :return: The font_size_metadata of this FormulaTab. # noqa: E501 1640 :rtype: PropertyMetadata 1641 """ 1642 return self._font_size_metadata 1643 1644 @font_size_metadata.setter 1645 def font_size_metadata(self, font_size_metadata): 1646 """Sets the font_size_metadata of this FormulaTab. 1647 1648 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1649 1650 :param font_size_metadata: The font_size_metadata of this FormulaTab. # noqa: E501 1651 :type: PropertyMetadata 1652 """ 1653 1654 self._font_size_metadata = font_size_metadata 1655 1656 @property 1657 def form_order(self): 1658 """Gets the form_order of this FormulaTab. # noqa: E501 1659 1660 # noqa: E501 1661 1662 :return: The form_order of this FormulaTab. # noqa: E501 1663 :rtype: str 1664 """ 1665 return self._form_order 1666 1667 @form_order.setter 1668 def form_order(self, form_order): 1669 """Sets the form_order of this FormulaTab. 1670 1671 # noqa: E501 1672 1673 :param form_order: The form_order of this FormulaTab. # noqa: E501 1674 :type: str 1675 """ 1676 1677 self._form_order = form_order 1678 1679 @property 1680 def form_order_metadata(self): 1681 """Gets the form_order_metadata of this FormulaTab. # noqa: E501 1682 1683 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1684 1685 :return: The form_order_metadata of this FormulaTab. # noqa: E501 1686 :rtype: PropertyMetadata 1687 """ 1688 return self._form_order_metadata 1689 1690 @form_order_metadata.setter 1691 def form_order_metadata(self, form_order_metadata): 1692 """Sets the form_order_metadata of this FormulaTab. 1693 1694 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1695 1696 :param form_order_metadata: The form_order_metadata of this FormulaTab. # noqa: E501 1697 :type: PropertyMetadata 1698 """ 1699 1700 self._form_order_metadata = form_order_metadata 1701 1702 @property 1703 def form_page_label(self): 1704 """Gets the form_page_label of this FormulaTab. # noqa: E501 1705 1706 # noqa: E501 1707 1708 :return: The form_page_label of this FormulaTab. # noqa: E501 1709 :rtype: str 1710 """ 1711 return self._form_page_label 1712 1713 @form_page_label.setter 1714 def form_page_label(self, form_page_label): 1715 """Sets the form_page_label of this FormulaTab. 1716 1717 # noqa: E501 1718 1719 :param form_page_label: The form_page_label of this FormulaTab. # noqa: E501 1720 :type: str 1721 """ 1722 1723 self._form_page_label = form_page_label 1724 1725 @property 1726 def form_page_label_metadata(self): 1727 """Gets the form_page_label_metadata of this FormulaTab. # noqa: E501 1728 1729 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1730 1731 :return: The form_page_label_metadata of this FormulaTab. # noqa: E501 1732 :rtype: PropertyMetadata 1733 """ 1734 return self._form_page_label_metadata 1735 1736 @form_page_label_metadata.setter 1737 def form_page_label_metadata(self, form_page_label_metadata): 1738 """Sets the form_page_label_metadata of this FormulaTab. 1739 1740 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1741 1742 :param form_page_label_metadata: The form_page_label_metadata of this FormulaTab. # noqa: E501 1743 :type: PropertyMetadata 1744 """ 1745 1746 self._form_page_label_metadata = form_page_label_metadata 1747 1748 @property 1749 def form_page_number(self): 1750 """Gets the form_page_number of this FormulaTab. # noqa: E501 1751 1752 # noqa: E501 1753 1754 :return: The form_page_number of this FormulaTab. # noqa: E501 1755 :rtype: str 1756 """ 1757 return self._form_page_number 1758 1759 @form_page_number.setter 1760 def form_page_number(self, form_page_number): 1761 """Sets the form_page_number of this FormulaTab. 1762 1763 # noqa: E501 1764 1765 :param form_page_number: The form_page_number of this FormulaTab. # noqa: E501 1766 :type: str 1767 """ 1768 1769 self._form_page_number = form_page_number 1770 1771 @property 1772 def form_page_number_metadata(self): 1773 """Gets the form_page_number_metadata of this FormulaTab. # noqa: E501 1774 1775 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1776 1777 :return: The form_page_number_metadata of this FormulaTab. # noqa: E501 1778 :rtype: PropertyMetadata 1779 """ 1780 return self._form_page_number_metadata 1781 1782 @form_page_number_metadata.setter 1783 def form_page_number_metadata(self, form_page_number_metadata): 1784 """Sets the form_page_number_metadata of this FormulaTab. 1785 1786 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1787 1788 :param form_page_number_metadata: The form_page_number_metadata of this FormulaTab. # noqa: E501 1789 :type: PropertyMetadata 1790 """ 1791 1792 self._form_page_number_metadata = form_page_number_metadata 1793 1794 @property 1795 def formula(self): 1796 """Gets the formula of this FormulaTab. # noqa: E501 1797 1798 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501 1799 1800 :return: The formula of this FormulaTab. # noqa: E501 1801 :rtype: str 1802 """ 1803 return self._formula 1804 1805 @formula.setter 1806 def formula(self, formula): 1807 """Sets the formula of this FormulaTab. 1808 1809 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501 1810 1811 :param formula: The formula of this FormulaTab. # noqa: E501 1812 :type: str 1813 """ 1814 1815 self._formula = formula 1816 1817 @property 1818 def formula_metadata(self): 1819 """Gets the formula_metadata of this FormulaTab. # noqa: E501 1820 1821 Metadata indicating if the sender can edit the `formula` property. # noqa: E501 1822 1823 :return: The formula_metadata of this FormulaTab. # noqa: E501 1824 :rtype: PropertyMetadata 1825 """ 1826 return self._formula_metadata 1827 1828 @formula_metadata.setter 1829 def formula_metadata(self, formula_metadata): 1830 """Sets the formula_metadata of this FormulaTab. 1831 1832 Metadata indicating if the sender can edit the `formula` property. # noqa: E501 1833 1834 :param formula_metadata: The formula_metadata of this FormulaTab. # noqa: E501 1835 :type: PropertyMetadata 1836 """ 1837 1838 self._formula_metadata = formula_metadata 1839 1840 @property 1841 def height(self): 1842 """Gets the height of this FormulaTab. # noqa: E501 1843 1844 Height of the tab in pixels. # noqa: E501 1845 1846 :return: The height of this FormulaTab. # noqa: E501 1847 :rtype: str 1848 """ 1849 return self._height 1850 1851 @height.setter 1852 def height(self, height): 1853 """Sets the height of this FormulaTab. 1854 1855 Height of the tab in pixels. # noqa: E501 1856 1857 :param height: The height of this FormulaTab. # noqa: E501 1858 :type: str 1859 """ 1860 1861 self._height = height 1862 1863 @property 1864 def height_metadata(self): 1865 """Gets the height_metadata of this FormulaTab. # noqa: E501 1866 1867 Metadata that indicates whether the `height` property is editable. # noqa: E501 1868 1869 :return: The height_metadata of this FormulaTab. # noqa: E501 1870 :rtype: PropertyMetadata 1871 """ 1872 return self._height_metadata 1873 1874 @height_metadata.setter 1875 def height_metadata(self, height_metadata): 1876 """Sets the height_metadata of this FormulaTab. 1877 1878 Metadata that indicates whether the `height` property is editable. # noqa: E501 1879 1880 :param height_metadata: The height_metadata of this FormulaTab. # noqa: E501 1881 :type: PropertyMetadata 1882 """ 1883 1884 self._height_metadata = height_metadata 1885 1886 @property 1887 def hidden(self): 1888 """Gets the hidden of this FormulaTab. # noqa: E501 1889 1890 # noqa: E501 1891 1892 :return: The hidden of this FormulaTab. # noqa: E501 1893 :rtype: str 1894 """ 1895 return self._hidden 1896 1897 @hidden.setter 1898 def hidden(self, hidden): 1899 """Sets the hidden of this FormulaTab. 1900 1901 # noqa: E501 1902 1903 :param hidden: The hidden of this FormulaTab. # noqa: E501 1904 :type: str 1905 """ 1906 1907 self._hidden = hidden 1908 1909 @property 1910 def hidden_metadata(self): 1911 """Gets the hidden_metadata of this FormulaTab. # noqa: E501 1912 1913 Metadata that indicates whether the `hidden` property is editable. # noqa: E501 1914 1915 :return: The hidden_metadata of this FormulaTab. # noqa: E501 1916 :rtype: PropertyMetadata 1917 """ 1918 return self._hidden_metadata 1919 1920 @hidden_metadata.setter 1921 def hidden_metadata(self, hidden_metadata): 1922 """Sets the hidden_metadata of this FormulaTab. 1923 1924 Metadata that indicates whether the `hidden` property is editable. # noqa: E501 1925 1926 :param hidden_metadata: The hidden_metadata of this FormulaTab. # noqa: E501 1927 :type: PropertyMetadata 1928 """ 1929 1930 self._hidden_metadata = hidden_metadata 1931 1932 @property 1933 def is_payment_amount(self): 1934 """Gets the is_payment_amount of this FormulaTab. # noqa: E501 1935 1936 When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501 1937 1938 :return: The is_payment_amount of this FormulaTab. # noqa: E501 1939 :rtype: str 1940 """ 1941 return self._is_payment_amount 1942 1943 @is_payment_amount.setter 1944 def is_payment_amount(self, is_payment_amount): 1945 """Sets the is_payment_amount of this FormulaTab. 1946 1947 When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501 1948 1949 :param is_payment_amount: The is_payment_amount of this FormulaTab. # noqa: E501 1950 :type: str 1951 """ 1952 1953 self._is_payment_amount = is_payment_amount 1954 1955 @property 1956 def is_payment_amount_metadata(self): 1957 """Gets the is_payment_amount_metadata of this FormulaTab. # noqa: E501 1958 1959 Reserved for DocuSign. # noqa: E501 1960 1961 :return: The is_payment_amount_metadata of this FormulaTab. # noqa: E501 1962 :rtype: PropertyMetadata 1963 """ 1964 return self._is_payment_amount_metadata 1965 1966 @is_payment_amount_metadata.setter 1967 def is_payment_amount_metadata(self, is_payment_amount_metadata): 1968 """Sets the is_payment_amount_metadata of this FormulaTab. 1969 1970 Reserved for DocuSign. # noqa: E501 1971 1972 :param is_payment_amount_metadata: The is_payment_amount_metadata of this FormulaTab. # noqa: E501 1973 :type: PropertyMetadata 1974 """ 1975 1976 self._is_payment_amount_metadata = is_payment_amount_metadata 1977 1978 @property 1979 def italic(self): 1980 """Gets the italic of this FormulaTab. # noqa: E501 1981 1982 When set to **true**, the information in the tab is italic. # noqa: E501 1983 1984 :return: The italic of this FormulaTab. # noqa: E501 1985 :rtype: str 1986 """ 1987 return self._italic 1988 1989 @italic.setter 1990 def italic(self, italic): 1991 """Sets the italic of this FormulaTab. 1992 1993 When set to **true**, the information in the tab is italic. # noqa: E501 1994 1995 :param italic: The italic of this FormulaTab. # noqa: E501 1996 :type: str 1997 """ 1998 1999 self._italic = italic 2000 2001 @property 2002 def italic_metadata(self): 2003 """Gets the italic_metadata of this FormulaTab. # noqa: E501 2004 2005 Metadata that indicates whether the `italic` property is editable. # noqa: E501 2006 2007 :return: The italic_metadata of this FormulaTab. # noqa: E501 2008 :rtype: PropertyMetadata 2009 """ 2010 return self._italic_metadata 2011 2012 @italic_metadata.setter 2013 def italic_metadata(self, italic_metadata): 2014 """Sets the italic_metadata of this FormulaTab. 2015 2016 Metadata that indicates whether the `italic` property is editable. # noqa: E501 2017 2018 :param italic_metadata: The italic_metadata of this FormulaTab. # noqa: E501 2019 :type: PropertyMetadata 2020 """ 2021 2022 self._italic_metadata = italic_metadata 2023 2024 @property 2025 def locale_policy(self): 2026 """Gets the locale_policy of this FormulaTab. # noqa: E501 2027 2028 Reserved for DocuSign. # noqa: E501 2029 2030 :return: The locale_policy of this FormulaTab. # noqa: E501 2031 :rtype: LocalePolicyTab 2032 """ 2033 return self._locale_policy 2034 2035 @locale_policy.setter 2036 def locale_policy(self, locale_policy): 2037 """Sets the locale_policy of this FormulaTab. 2038 2039 Reserved for DocuSign. # noqa: E501 2040 2041 :param locale_policy: The locale_policy of this FormulaTab. # noqa: E501 2042 :type: LocalePolicyTab 2043 """ 2044 2045 self._locale_policy = locale_policy 2046 2047 @property 2048 def locked(self): 2049 """Gets the locked of this FormulaTab. # noqa: E501 2050 2051 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 2052 2053 :return: The locked of this FormulaTab. # noqa: E501 2054 :rtype: str 2055 """ 2056 return self._locked 2057 2058 @locked.setter 2059 def locked(self, locked): 2060 """Sets the locked of this FormulaTab. 2061 2062 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 2063 2064 :param locked: The locked of this FormulaTab. # noqa: E501 2065 :type: str 2066 """ 2067 2068 self._locked = locked 2069 2070 @property 2071 def locked_metadata(self): 2072 """Gets the locked_metadata of this FormulaTab. # noqa: E501 2073 2074 Metadata that indicates whether the `locked` property is editable. # noqa: E501 2075 2076 :return: The locked_metadata of this FormulaTab. # noqa: E501 2077 :rtype: PropertyMetadata 2078 """ 2079 return self._locked_metadata 2080 2081 @locked_metadata.setter 2082 def locked_metadata(self, locked_metadata): 2083 """Sets the locked_metadata of this FormulaTab. 2084 2085 Metadata that indicates whether the `locked` property is editable. # noqa: E501 2086 2087 :param locked_metadata: The locked_metadata of this FormulaTab. # noqa: E501 2088 :type: PropertyMetadata 2089 """ 2090 2091 self._locked_metadata = locked_metadata 2092 2093 @property 2094 def max_length(self): 2095 """Gets the max_length of this FormulaTab. # noqa: E501 2096 2097 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 2098 2099 :return: The max_length of this FormulaTab. # noqa: E501 2100 :rtype: str 2101 """ 2102 return self._max_length 2103 2104 @max_length.setter 2105 def max_length(self, max_length): 2106 """Sets the max_length of this FormulaTab. 2107 2108 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 2109 2110 :param max_length: The max_length of this FormulaTab. # noqa: E501 2111 :type: str 2112 """ 2113 2114 self._max_length = max_length 2115 2116 @property 2117 def max_length_metadata(self): 2118 """Gets the max_length_metadata of this FormulaTab. # noqa: E501 2119 2120 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 2121 2122 :return: The max_length_metadata of this FormulaTab. # noqa: E501 2123 :rtype: PropertyMetadata 2124 """ 2125 return self._max_length_metadata 2126 2127 @max_length_metadata.setter 2128 def max_length_metadata(self, max_length_metadata): 2129 """Sets the max_length_metadata of this FormulaTab. 2130 2131 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 2132 2133 :param max_length_metadata: The max_length_metadata of this FormulaTab. # noqa: E501 2134 :type: PropertyMetadata 2135 """ 2136 2137 self._max_length_metadata = max_length_metadata 2138 2139 @property 2140 def merge_field(self): 2141 """Gets the merge_field of this FormulaTab. # noqa: E501 2142 2143 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 2144 2145 :return: The merge_field of this FormulaTab. # noqa: E501 2146 :rtype: MergeField 2147 """ 2148 return self._merge_field 2149 2150 @merge_field.setter 2151 def merge_field(self, merge_field): 2152 """Sets the merge_field of this FormulaTab. 2153 2154 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 2155 2156 :param merge_field: The merge_field of this FormulaTab. # noqa: E501 2157 :type: MergeField 2158 """ 2159 2160 self._merge_field = merge_field 2161 2162 @property 2163 def merge_field_xml(self): 2164 """Gets the merge_field_xml of this FormulaTab. # noqa: E501 2165 2166 # noqa: E501 2167 2168 :return: The merge_field_xml of this FormulaTab. # noqa: E501 2169 :rtype: str 2170 """ 2171 return self._merge_field_xml 2172 2173 @merge_field_xml.setter 2174 def merge_field_xml(self, merge_field_xml): 2175 """Sets the merge_field_xml of this FormulaTab. 2176 2177 # noqa: E501 2178 2179 :param merge_field_xml: The merge_field_xml of this FormulaTab. # noqa: E501 2180 :type: str 2181 """ 2182 2183 self._merge_field_xml = merge_field_xml 2184 2185 @property 2186 def name(self): 2187 """Gets the name of this FormulaTab. # noqa: E501 2188 2189 # noqa: E501 2190 2191 :return: The name of this FormulaTab. # noqa: E501 2192 :rtype: str 2193 """ 2194 return self._name 2195 2196 @name.setter 2197 def name(self, name): 2198 """Sets the name of this FormulaTab. 2199 2200 # noqa: E501 2201 2202 :param name: The name of this FormulaTab. # noqa: E501 2203 :type: str 2204 """ 2205 2206 self._name = name 2207 2208 @property 2209 def name_metadata(self): 2210 """Gets the name_metadata of this FormulaTab. # noqa: E501 2211 2212 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2213 2214 :return: The name_metadata of this FormulaTab. # noqa: E501 2215 :rtype: PropertyMetadata 2216 """ 2217 return self._name_metadata 2218 2219 @name_metadata.setter 2220 def name_metadata(self, name_metadata): 2221 """Sets the name_metadata of this FormulaTab. 2222 2223 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2224 2225 :param name_metadata: The name_metadata of this FormulaTab. # noqa: E501 2226 :type: PropertyMetadata 2227 """ 2228 2229 self._name_metadata = name_metadata 2230 2231 @property 2232 def original_value(self): 2233 """Gets the original_value of this FormulaTab. # noqa: E501 2234 2235 The initial value of the tab when it was sent to the recipient. # noqa: E501 2236 2237 :return: The original_value of this FormulaTab. # noqa: E501 2238 :rtype: str 2239 """ 2240 return self._original_value 2241 2242 @original_value.setter 2243 def original_value(self, original_value): 2244 """Sets the original_value of this FormulaTab. 2245 2246 The initial value of the tab when it was sent to the recipient. # noqa: E501 2247 2248 :param original_value: The original_value of this FormulaTab. # noqa: E501 2249 :type: str 2250 """ 2251 2252 self._original_value = original_value 2253 2254 @property 2255 def original_value_metadata(self): 2256 """Gets the original_value_metadata of this FormulaTab. # noqa: E501 2257 2258 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2259 2260 :return: The original_value_metadata of this FormulaTab. # noqa: E501 2261 :rtype: PropertyMetadata 2262 """ 2263 return self._original_value_metadata 2264 2265 @original_value_metadata.setter 2266 def original_value_metadata(self, original_value_metadata): 2267 """Sets the original_value_metadata of this FormulaTab. 2268 2269 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2270 2271 :param original_value_metadata: The original_value_metadata of this FormulaTab. # noqa: E501 2272 :type: PropertyMetadata 2273 """ 2274 2275 self._original_value_metadata = original_value_metadata 2276 2277 @property 2278 def page_number(self): 2279 """Gets the page_number of this FormulaTab. # noqa: E501 2280 2281 Specifies the page number on which the tab is located. # noqa: E501 2282 2283 :return: The page_number of this FormulaTab. # noqa: E501 2284 :rtype: str 2285 """ 2286 return self._page_number 2287 2288 @page_number.setter 2289 def page_number(self, page_number): 2290 """Sets the page_number of this FormulaTab. 2291 2292 Specifies the page number on which the tab is located. # noqa: E501 2293 2294 :param page_number: The page_number of this FormulaTab. # noqa: E501 2295 :type: str 2296 """ 2297 2298 self._page_number = page_number 2299 2300 @property 2301 def page_number_metadata(self): 2302 """Gets the page_number_metadata of this FormulaTab. # noqa: E501 2303 2304 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2305 2306 :return: The page_number_metadata of this FormulaTab. # noqa: E501 2307 :rtype: PropertyMetadata 2308 """ 2309 return self._page_number_metadata 2310 2311 @page_number_metadata.setter 2312 def page_number_metadata(self, page_number_metadata): 2313 """Sets the page_number_metadata of this FormulaTab. 2314 2315 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2316 2317 :param page_number_metadata: The page_number_metadata of this FormulaTab. # noqa: E501 2318 :type: PropertyMetadata 2319 """ 2320 2321 self._page_number_metadata = page_number_metadata 2322 2323 @property 2324 def payment_details(self): 2325 """Gets the payment_details of this FormulaTab. # noqa: E501 2326 2327 This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501 2328 2329 :return: The payment_details of this FormulaTab. # noqa: E501 2330 :rtype: PaymentDetails 2331 """ 2332 return self._payment_details 2333 2334 @payment_details.setter 2335 def payment_details(self, payment_details): 2336 """Sets the payment_details of this FormulaTab. 2337 2338 This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501 2339 2340 :param payment_details: The payment_details of this FormulaTab. # noqa: E501 2341 :type: PaymentDetails 2342 """ 2343 2344 self._payment_details = payment_details 2345 2346 @property 2347 def recipient_id(self): 2348 """Gets the recipient_id of this FormulaTab. # noqa: E501 2349 2350 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2351 2352 :return: The recipient_id of this FormulaTab. # noqa: E501 2353 :rtype: str 2354 """ 2355 return self._recipient_id 2356 2357 @recipient_id.setter 2358 def recipient_id(self, recipient_id): 2359 """Sets the recipient_id of this FormulaTab. 2360 2361 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2362 2363 :param recipient_id: The recipient_id of this FormulaTab. # noqa: E501 2364 :type: str 2365 """ 2366 2367 self._recipient_id = recipient_id 2368 2369 @property 2370 def recipient_id_guid(self): 2371 """Gets the recipient_id_guid of this FormulaTab. # noqa: E501 2372 2373 # noqa: E501 2374 2375 :return: The recipient_id_guid of this FormulaTab. # noqa: E501 2376 :rtype: str 2377 """ 2378 return self._recipient_id_guid 2379 2380 @recipient_id_guid.setter 2381 def recipient_id_guid(self, recipient_id_guid): 2382 """Sets the recipient_id_guid of this FormulaTab. 2383 2384 # noqa: E501 2385 2386 :param recipient_id_guid: The recipient_id_guid of this FormulaTab. # noqa: E501 2387 :type: str 2388 """ 2389 2390 self._recipient_id_guid = recipient_id_guid 2391 2392 @property 2393 def recipient_id_guid_metadata(self): 2394 """Gets the recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2395 2396 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2397 2398 :return: The recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2399 :rtype: PropertyMetadata 2400 """ 2401 return self._recipient_id_guid_metadata 2402 2403 @recipient_id_guid_metadata.setter 2404 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 2405 """Sets the recipient_id_guid_metadata of this FormulaTab. 2406 2407 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2408 2409 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2410 :type: PropertyMetadata 2411 """ 2412 2413 self._recipient_id_guid_metadata = recipient_id_guid_metadata 2414 2415 @property 2416 def recipient_id_metadata(self): 2417 """Gets the recipient_id_metadata of this FormulaTab. # noqa: E501 2418 2419 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2420 2421 :return: The recipient_id_metadata of this FormulaTab. # noqa: E501 2422 :rtype: PropertyMetadata 2423 """ 2424 return self._recipient_id_metadata 2425 2426 @recipient_id_metadata.setter 2427 def recipient_id_metadata(self, recipient_id_metadata): 2428 """Sets the recipient_id_metadata of this FormulaTab. 2429 2430 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2431 2432 :param recipient_id_metadata: The recipient_id_metadata of this FormulaTab. # noqa: E501 2433 :type: PropertyMetadata 2434 """ 2435 2436 self._recipient_id_metadata = recipient_id_metadata 2437 2438 @property 2439 def require_all(self): 2440 """Gets the require_all of this FormulaTab. # noqa: E501 2441 2442 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2443 2444 :return: The require_all of this FormulaTab. # noqa: E501 2445 :rtype: str 2446 """ 2447 return self._require_all 2448 2449 @require_all.setter 2450 def require_all(self, require_all): 2451 """Sets the require_all of this FormulaTab. 2452 2453 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2454 2455 :param require_all: The require_all of this FormulaTab. # noqa: E501 2456 :type: str 2457 """ 2458 2459 self._require_all = require_all 2460 2461 @property 2462 def require_all_metadata(self): 2463 """Gets the require_all_metadata of this FormulaTab. # noqa: E501 2464 2465 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2466 2467 :return: The require_all_metadata of this FormulaTab. # noqa: E501 2468 :rtype: PropertyMetadata 2469 """ 2470 return self._require_all_metadata 2471 2472 @require_all_metadata.setter 2473 def require_all_metadata(self, require_all_metadata): 2474 """Sets the require_all_metadata of this FormulaTab. 2475 2476 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2477 2478 :param require_all_metadata: The require_all_metadata of this FormulaTab. # noqa: E501 2479 :type: PropertyMetadata 2480 """ 2481 2482 self._require_all_metadata = require_all_metadata 2483 2484 @property 2485 def required(self): 2486 """Gets the required of this FormulaTab. # noqa: E501 2487 2488 When set to **true**, the signer is required to fill out this tab # noqa: E501 2489 2490 :return: The required of this FormulaTab. # noqa: E501 2491 :rtype: str 2492 """ 2493 return self._required 2494 2495 @required.setter 2496 def required(self, required): 2497 """Sets the required of this FormulaTab. 2498 2499 When set to **true**, the signer is required to fill out this tab # noqa: E501 2500 2501 :param required: The required of this FormulaTab. # noqa: E501 2502 :type: str 2503 """ 2504 2505 self._required = required 2506 2507 @property 2508 def required_metadata(self): 2509 """Gets the required_metadata of this FormulaTab. # noqa: E501 2510 2511 Metadata that indicates whether the `required` property is editable. # noqa: E501 2512 2513 :return: The required_metadata of this FormulaTab. # noqa: E501 2514 :rtype: PropertyMetadata 2515 """ 2516 return self._required_metadata 2517 2518 @required_metadata.setter 2519 def required_metadata(self, required_metadata): 2520 """Sets the required_metadata of this FormulaTab. 2521 2522 Metadata that indicates whether the `required` property is editable. # noqa: E501 2523 2524 :param required_metadata: The required_metadata of this FormulaTab. # noqa: E501 2525 :type: PropertyMetadata 2526 """ 2527 2528 self._required_metadata = required_metadata 2529 2530 @property 2531 def require_initial_on_shared_change(self): 2532 """Gets the require_initial_on_shared_change of this FormulaTab. # noqa: E501 2533 2534 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2535 2536 :return: The require_initial_on_shared_change of this FormulaTab. # noqa: E501 2537 :rtype: str 2538 """ 2539 return self._require_initial_on_shared_change 2540 2541 @require_initial_on_shared_change.setter 2542 def require_initial_on_shared_change(self, require_initial_on_shared_change): 2543 """Sets the require_initial_on_shared_change of this FormulaTab. 2544 2545 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2546 2547 :param require_initial_on_shared_change: The require_initial_on_shared_change of this FormulaTab. # noqa: E501 2548 :type: str 2549 """ 2550 2551 self._require_initial_on_shared_change = require_initial_on_shared_change 2552 2553 @property 2554 def require_initial_on_shared_change_metadata(self): 2555 """Gets the require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2556 2557 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2558 2559 :return: The require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2560 :rtype: PropertyMetadata 2561 """ 2562 return self._require_initial_on_shared_change_metadata 2563 2564 @require_initial_on_shared_change_metadata.setter 2565 def require_initial_on_shared_change_metadata(self, require_initial_on_shared_change_metadata): 2566 """Sets the require_initial_on_shared_change_metadata of this FormulaTab. 2567 2568 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2569 2570 :param require_initial_on_shared_change_metadata: The require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2571 :type: PropertyMetadata 2572 """ 2573 2574 self._require_initial_on_shared_change_metadata = require_initial_on_shared_change_metadata 2575 2576 @property 2577 def round_decimal_places(self): 2578 """Gets the round_decimal_places of this FormulaTab. # noqa: E501 2579 2580 # noqa: E501 2581 2582 :return: The round_decimal_places of this FormulaTab. # noqa: E501 2583 :rtype: str 2584 """ 2585 return self._round_decimal_places 2586 2587 @round_decimal_places.setter 2588 def round_decimal_places(self, round_decimal_places): 2589 """Sets the round_decimal_places of this FormulaTab. 2590 2591 # noqa: E501 2592 2593 :param round_decimal_places: The round_decimal_places of this FormulaTab. # noqa: E501 2594 :type: str 2595 """ 2596 2597 self._round_decimal_places = round_decimal_places 2598 2599 @property 2600 def round_decimal_places_metadata(self): 2601 """Gets the round_decimal_places_metadata of this FormulaTab. # noqa: E501 2602 2603 Metadata that indicates whether the `roundDecimalPlaces` property is editable. # noqa: E501 2604 2605 :return: The round_decimal_places_metadata of this FormulaTab. # noqa: E501 2606 :rtype: PropertyMetadata 2607 """ 2608 return self._round_decimal_places_metadata 2609 2610 @round_decimal_places_metadata.setter 2611 def round_decimal_places_metadata(self, round_decimal_places_metadata): 2612 """Sets the round_decimal_places_metadata of this FormulaTab. 2613 2614 Metadata that indicates whether the `roundDecimalPlaces` property is editable. # noqa: E501 2615 2616 :param round_decimal_places_metadata: The round_decimal_places_metadata of this FormulaTab. # noqa: E501 2617 :type: PropertyMetadata 2618 """ 2619 2620 self._round_decimal_places_metadata = round_decimal_places_metadata 2621 2622 @property 2623 def sender_required(self): 2624 """Gets the sender_required of this FormulaTab. # noqa: E501 2625 2626 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2627 2628 :return: The sender_required of this FormulaTab. # noqa: E501 2629 :rtype: str 2630 """ 2631 return self._sender_required 2632 2633 @sender_required.setter 2634 def sender_required(self, sender_required): 2635 """Sets the sender_required of this FormulaTab. 2636 2637 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2638 2639 :param sender_required: The sender_required of this FormulaTab. # noqa: E501 2640 :type: str 2641 """ 2642 2643 self._sender_required = sender_required 2644 2645 @property 2646 def sender_required_metadata(self): 2647 """Gets the sender_required_metadata of this FormulaTab. # noqa: E501 2648 2649 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2650 2651 :return: The sender_required_metadata of this FormulaTab. # noqa: E501 2652 :rtype: PropertyMetadata 2653 """ 2654 return self._sender_required_metadata 2655 2656 @sender_required_metadata.setter 2657 def sender_required_metadata(self, sender_required_metadata): 2658 """Sets the sender_required_metadata of this FormulaTab. 2659 2660 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2661 2662 :param sender_required_metadata: The sender_required_metadata of this FormulaTab. # noqa: E501 2663 :type: PropertyMetadata 2664 """ 2665 2666 self._sender_required_metadata = sender_required_metadata 2667 2668 @property 2669 def shared(self): 2670 """Gets the shared of this FormulaTab. # noqa: E501 2671 2672 When set to **true**, this custom tab is shared. # noqa: E501 2673 2674 :return: The shared of this FormulaTab. # noqa: E501 2675 :rtype: str 2676 """ 2677 return self._shared 2678 2679 @shared.setter 2680 def shared(self, shared): 2681 """Sets the shared of this FormulaTab. 2682 2683 When set to **true**, this custom tab is shared. # noqa: E501 2684 2685 :param shared: The shared of this FormulaTab. # noqa: E501 2686 :type: str 2687 """ 2688 2689 self._shared = shared 2690 2691 @property 2692 def shared_metadata(self): 2693 """Gets the shared_metadata of this FormulaTab. # noqa: E501 2694 2695 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2696 2697 :return: The shared_metadata of this FormulaTab. # noqa: E501 2698 :rtype: PropertyMetadata 2699 """ 2700 return self._shared_metadata 2701 2702 @shared_metadata.setter 2703 def shared_metadata(self, shared_metadata): 2704 """Sets the shared_metadata of this FormulaTab. 2705 2706 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2707 2708 :param shared_metadata: The shared_metadata of this FormulaTab. # noqa: E501 2709 :type: PropertyMetadata 2710 """ 2711 2712 self._shared_metadata = shared_metadata 2713 2714 @property 2715 def share_to_recipients(self): 2716 """Gets the share_to_recipients of this FormulaTab. # noqa: E501 2717 2718 # noqa: E501 2719 2720 :return: The share_to_recipients of this FormulaTab. # noqa: E501 2721 :rtype: str 2722 """ 2723 return self._share_to_recipients 2724 2725 @share_to_recipients.setter 2726 def share_to_recipients(self, share_to_recipients): 2727 """Sets the share_to_recipients of this FormulaTab. 2728 2729 # noqa: E501 2730 2731 :param share_to_recipients: The share_to_recipients of this FormulaTab. # noqa: E501 2732 :type: str 2733 """ 2734 2735 self._share_to_recipients = share_to_recipients 2736 2737 @property 2738 def share_to_recipients_metadata(self): 2739 """Gets the share_to_recipients_metadata of this FormulaTab. # noqa: E501 2740 2741 Reserved for DocuSign. # noqa: E501 2742 2743 :return: The share_to_recipients_metadata of this FormulaTab. # noqa: E501 2744 :rtype: PropertyMetadata 2745 """ 2746 return self._share_to_recipients_metadata 2747 2748 @share_to_recipients_metadata.setter 2749 def share_to_recipients_metadata(self, share_to_recipients_metadata): 2750 """Sets the share_to_recipients_metadata of this FormulaTab. 2751 2752 Reserved for DocuSign. # noqa: E501 2753 2754 :param share_to_recipients_metadata: The share_to_recipients_metadata of this FormulaTab. # noqa: E501 2755 :type: PropertyMetadata 2756 """ 2757 2758 self._share_to_recipients_metadata = share_to_recipients_metadata 2759 2760 @property 2761 def smart_contract_information(self): 2762 """Gets the smart_contract_information of this FormulaTab. # noqa: E501 2763 2764 Reserved for DocuSign. # noqa: E501 2765 2766 :return: The smart_contract_information of this FormulaTab. # noqa: E501 2767 :rtype: SmartContractInformation 2768 """ 2769 return self._smart_contract_information 2770 2771 @smart_contract_information.setter 2772 def smart_contract_information(self, smart_contract_information): 2773 """Sets the smart_contract_information of this FormulaTab. 2774 2775 Reserved for DocuSign. # noqa: E501 2776 2777 :param smart_contract_information: The smart_contract_information of this FormulaTab. # noqa: E501 2778 :type: SmartContractInformation 2779 """ 2780 2781 self._smart_contract_information = smart_contract_information 2782 2783 @property 2784 def source(self): 2785 """Gets the source of this FormulaTab. # noqa: E501 2786 2787 # noqa: E501 2788 2789 :return: The source of this FormulaTab. # noqa: E501 2790 :rtype: str 2791 """ 2792 return self._source 2793 2794 @source.setter 2795 def source(self, source): 2796 """Sets the source of this FormulaTab. 2797 2798 # noqa: E501 2799 2800 :param source: The source of this FormulaTab. # noqa: E501 2801 :type: str 2802 """ 2803 2804 self._source = source 2805 2806 @property 2807 def status(self): 2808 """Gets the status of this FormulaTab. # noqa: E501 2809 2810 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 2811 2812 :return: The status of this FormulaTab. # noqa: E501 2813 :rtype: str 2814 """ 2815 return self._status 2816 2817 @status.setter 2818 def status(self, status): 2819 """Sets the status of this FormulaTab. 2820 2821 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 2822 2823 :param status: The status of this FormulaTab. # noqa: E501 2824 :type: str 2825 """ 2826 2827 self._status = status 2828 2829 @property 2830 def status_metadata(self): 2831 """Gets the status_metadata of this FormulaTab. # noqa: E501 2832 2833 Metadata that indicates whether the `status` property is editable. # noqa: E501 2834 2835 :return: The status_metadata of this FormulaTab. # noqa: E501 2836 :rtype: PropertyMetadata 2837 """ 2838 return self._status_metadata 2839 2840 @status_metadata.setter 2841 def status_metadata(self, status_metadata): 2842 """Sets the status_metadata of this FormulaTab. 2843 2844 Metadata that indicates whether the `status` property is editable. # noqa: E501 2845 2846 :param status_metadata: The status_metadata of this FormulaTab. # noqa: E501 2847 :type: PropertyMetadata 2848 """ 2849 2850 self._status_metadata = status_metadata 2851 2852 @property 2853 def tab_fully_qualified_path(self): 2854 """Gets the tab_fully_qualified_path of this FormulaTab. # noqa: E501 2855 2856 # noqa: E501 2857 2858 :return: The tab_fully_qualified_path of this FormulaTab. # noqa: E501 2859 :rtype: str 2860 """ 2861 return self._tab_fully_qualified_path 2862 2863 @tab_fully_qualified_path.setter 2864 def tab_fully_qualified_path(self, tab_fully_qualified_path): 2865 """Sets the tab_fully_qualified_path of this FormulaTab. 2866 2867 # noqa: E501 2868 2869 :param tab_fully_qualified_path: The tab_fully_qualified_path of this FormulaTab. # noqa: E501 2870 :type: str 2871 """ 2872 2873 self._tab_fully_qualified_path = tab_fully_qualified_path 2874 2875 @property 2876 def tab_group_labels(self): 2877 """Gets the tab_group_labels of this FormulaTab. # noqa: E501 2878 2879 # noqa: E501 2880 2881 :return: The tab_group_labels of this FormulaTab. # noqa: E501 2882 :rtype: list[str] 2883 """ 2884 return self._tab_group_labels 2885 2886 @tab_group_labels.setter 2887 def tab_group_labels(self, tab_group_labels): 2888 """Sets the tab_group_labels of this FormulaTab. 2889 2890 # noqa: E501 2891 2892 :param tab_group_labels: The tab_group_labels of this FormulaTab. # noqa: E501 2893 :type: list[str] 2894 """ 2895 2896 self._tab_group_labels = tab_group_labels 2897 2898 @property 2899 def tab_group_labels_metadata(self): 2900 """Gets the tab_group_labels_metadata of this FormulaTab. # noqa: E501 2901 2902 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2903 2904 :return: The tab_group_labels_metadata of this FormulaTab. # noqa: E501 2905 :rtype: PropertyMetadata 2906 """ 2907 return self._tab_group_labels_metadata 2908 2909 @tab_group_labels_metadata.setter 2910 def tab_group_labels_metadata(self, tab_group_labels_metadata): 2911 """Sets the tab_group_labels_metadata of this FormulaTab. 2912 2913 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2914 2915 :param tab_group_labels_metadata: The tab_group_labels_metadata of this FormulaTab. # noqa: E501 2916 :type: PropertyMetadata 2917 """ 2918 2919 self._tab_group_labels_metadata = tab_group_labels_metadata 2920 2921 @property 2922 def tab_id(self): 2923 """Gets the tab_id of this FormulaTab. # noqa: E501 2924 2925 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2926 2927 :return: The tab_id of this FormulaTab. # noqa: E501 2928 :rtype: str 2929 """ 2930 return self._tab_id 2931 2932 @tab_id.setter 2933 def tab_id(self, tab_id): 2934 """Sets the tab_id of this FormulaTab. 2935 2936 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2937 2938 :param tab_id: The tab_id of this FormulaTab. # noqa: E501 2939 :type: str 2940 """ 2941 2942 self._tab_id = tab_id 2943 2944 @property 2945 def tab_id_metadata(self): 2946 """Gets the tab_id_metadata of this FormulaTab. # noqa: E501 2947 2948 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2949 2950 :return: The tab_id_metadata of this FormulaTab. # noqa: E501 2951 :rtype: PropertyMetadata 2952 """ 2953 return self._tab_id_metadata 2954 2955 @tab_id_metadata.setter 2956 def tab_id_metadata(self, tab_id_metadata): 2957 """Sets the tab_id_metadata of this FormulaTab. 2958 2959 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2960 2961 :param tab_id_metadata: The tab_id_metadata of this FormulaTab. # noqa: E501 2962 :type: PropertyMetadata 2963 """ 2964 2965 self._tab_id_metadata = tab_id_metadata 2966 2967 @property 2968 def tab_label(self): 2969 """Gets the tab_label of this FormulaTab. # noqa: E501 2970 2971 The label string associated with the tab. # noqa: E501 2972 2973 :return: The tab_label of this FormulaTab. # noqa: E501 2974 :rtype: str 2975 """ 2976 return self._tab_label 2977 2978 @tab_label.setter 2979 def tab_label(self, tab_label): 2980 """Sets the tab_label of this FormulaTab. 2981 2982 The label string associated with the tab. # noqa: E501 2983 2984 :param tab_label: The tab_label of this FormulaTab. # noqa: E501 2985 :type: str 2986 """ 2987 2988 self._tab_label = tab_label 2989 2990 @property 2991 def tab_label_metadata(self): 2992 """Gets the tab_label_metadata of this FormulaTab. # noqa: E501 2993 2994 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 2995 2996 :return: The tab_label_metadata of this FormulaTab. # noqa: E501 2997 :rtype: PropertyMetadata 2998 """ 2999 return self._tab_label_metadata 3000 3001 @tab_label_metadata.setter 3002 def tab_label_metadata(self, tab_label_metadata): 3003 """Sets the tab_label_metadata of this FormulaTab. 3004 3005 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 3006 3007 :param tab_label_metadata: The tab_label_metadata of this FormulaTab. # noqa: E501 3008 :type: PropertyMetadata 3009 """ 3010 3011 self._tab_label_metadata = tab_label_metadata 3012 3013 @property 3014 def tab_order(self): 3015 """Gets the tab_order of this FormulaTab. # noqa: E501 3016 3017 # noqa: E501 3018 3019 :return: The tab_order of this FormulaTab. # noqa: E501 3020 :rtype: str 3021 """ 3022 return self._tab_order 3023 3024 @tab_order.setter 3025 def tab_order(self, tab_order): 3026 """Sets the tab_order of this FormulaTab. 3027 3028 # noqa: E501 3029 3030 :param tab_order: The tab_order of this FormulaTab. # noqa: E501 3031 :type: str 3032 """ 3033 3034 self._tab_order = tab_order 3035 3036 @property 3037 def tab_order_metadata(self): 3038 """Gets the tab_order_metadata of this FormulaTab. # noqa: E501 3039 3040 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 3041 3042 :return: The tab_order_metadata of this FormulaTab. # noqa: E501 3043 :rtype: PropertyMetadata 3044 """ 3045 return self._tab_order_metadata 3046 3047 @tab_order_metadata.setter 3048 def tab_order_metadata(self, tab_order_metadata): 3049 """Sets the tab_order_metadata of this FormulaTab. 3050 3051 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 3052 3053 :param tab_order_metadata: The tab_order_metadata of this FormulaTab. # noqa: E501 3054 :type: PropertyMetadata 3055 """ 3056 3057 self._tab_order_metadata = tab_order_metadata 3058 3059 @property 3060 def tab_type(self): 3061 """Gets the tab_type of this FormulaTab. # noqa: E501 3062 3063 # noqa: E501 3064 3065 :return: The tab_type of this FormulaTab. # noqa: E501 3066 :rtype: str 3067 """ 3068 return self._tab_type 3069 3070 @tab_type.setter 3071 def tab_type(self, tab_type): 3072 """Sets the tab_type of this FormulaTab. 3073 3074 # noqa: E501 3075 3076 :param tab_type: The tab_type of this FormulaTab. # noqa: E501 3077 :type: str 3078 """ 3079 3080 self._tab_type = tab_type 3081 3082 @property 3083 def tab_type_metadata(self): 3084 """Gets the tab_type_metadata of this FormulaTab. # noqa: E501 3085 3086 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 3087 3088 :return: The tab_type_metadata of this FormulaTab. # noqa: E501 3089 :rtype: PropertyMetadata 3090 """ 3091 return self._tab_type_metadata 3092 3093 @tab_type_metadata.setter 3094 def tab_type_metadata(self, tab_type_metadata): 3095 """Sets the tab_type_metadata of this FormulaTab. 3096 3097 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 3098 3099 :param tab_type_metadata: The tab_type_metadata of this FormulaTab. # noqa: E501 3100 :type: PropertyMetadata 3101 """ 3102 3103 self._tab_type_metadata = tab_type_metadata 3104 3105 @property 3106 def template_locked(self): 3107 """Gets the template_locked of this FormulaTab. # noqa: E501 3108 3109 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 3110 3111 :return: The template_locked of this FormulaTab. # noqa: E501 3112 :rtype: str 3113 """ 3114 return self._template_locked 3115 3116 @template_locked.setter 3117 def template_locked(self, template_locked): 3118 """Sets the template_locked of this FormulaTab. 3119 3120 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 3121 3122 :param template_locked: The template_locked of this FormulaTab. # noqa: E501 3123 :type: str 3124 """ 3125 3126 self._template_locked = template_locked 3127 3128 @property 3129 def template_locked_metadata(self): 3130 """Gets the template_locked_metadata of this FormulaTab. # noqa: E501 3131 3132 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 3133 3134 :return: The template_locked_metadata of this FormulaTab. # noqa: E501 3135 :rtype: PropertyMetadata 3136 """ 3137 return self._template_locked_metadata 3138 3139 @template_locked_metadata.setter 3140 def template_locked_metadata(self, template_locked_metadata): 3141 """Sets the template_locked_metadata of this FormulaTab. 3142 3143 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 3144 3145 :param template_locked_metadata: The template_locked_metadata of this FormulaTab. # noqa: E501 3146 :type: PropertyMetadata 3147 """ 3148 3149 self._template_locked_metadata = template_locked_metadata 3150 3151 @property 3152 def template_required(self): 3153 """Gets the template_required of this FormulaTab. # noqa: E501 3154 3155 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 3156 3157 :return: The template_required of this FormulaTab. # noqa: E501 3158 :rtype: str 3159 """ 3160 return self._template_required 3161 3162 @template_required.setter 3163 def template_required(self, template_required): 3164 """Sets the template_required of this FormulaTab. 3165 3166 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 3167 3168 :param template_required: The template_required of this FormulaTab. # noqa: E501 3169 :type: str 3170 """ 3171 3172 self._template_required = template_required 3173 3174 @property 3175 def template_required_metadata(self): 3176 """Gets the template_required_metadata of this FormulaTab. # noqa: E501 3177 3178 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 3179 3180 :return: The template_required_metadata of this FormulaTab. # noqa: E501 3181 :rtype: PropertyMetadata 3182 """ 3183 return self._template_required_metadata 3184 3185 @template_required_metadata.setter 3186 def template_required_metadata(self, template_required_metadata): 3187 """Sets the template_required_metadata of this FormulaTab. 3188 3189 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 3190 3191 :param template_required_metadata: The template_required_metadata of this FormulaTab. # noqa: E501 3192 :type: PropertyMetadata 3193 """ 3194 3195 self._template_required_metadata = template_required_metadata 3196 3197 @property 3198 def tooltip(self): 3199 """Gets the tooltip of this FormulaTab. # noqa: E501 3200 3201 # noqa: E501 3202 3203 :return: The tooltip of this FormulaTab. # noqa: E501 3204 :rtype: str 3205 """ 3206 return self._tooltip 3207 3208 @tooltip.setter 3209 def tooltip(self, tooltip): 3210 """Sets the tooltip of this FormulaTab. 3211 3212 # noqa: E501 3213 3214 :param tooltip: The tooltip of this FormulaTab. # noqa: E501 3215 :type: str 3216 """ 3217 3218 self._tooltip = tooltip 3219 3220 @property 3221 def tool_tip_metadata(self): 3222 """Gets the tool_tip_metadata of this FormulaTab. # noqa: E501 3223 3224 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3225 3226 :return: The tool_tip_metadata of this FormulaTab. # noqa: E501 3227 :rtype: PropertyMetadata 3228 """ 3229 return self._tool_tip_metadata 3230 3231 @tool_tip_metadata.setter 3232 def tool_tip_metadata(self, tool_tip_metadata): 3233 """Sets the tool_tip_metadata of this FormulaTab. 3234 3235 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3236 3237 :param tool_tip_metadata: The tool_tip_metadata of this FormulaTab. # noqa: E501 3238 :type: PropertyMetadata 3239 """ 3240 3241 self._tool_tip_metadata = tool_tip_metadata 3242 3243 @property 3244 def underline(self): 3245 """Gets the underline of this FormulaTab. # noqa: E501 3246 3247 When set to **true**, the information in the tab is underlined. # noqa: E501 3248 3249 :return: The underline of this FormulaTab. # noqa: E501 3250 :rtype: str 3251 """ 3252 return self._underline 3253 3254 @underline.setter 3255 def underline(self, underline): 3256 """Sets the underline of this FormulaTab. 3257 3258 When set to **true**, the information in the tab is underlined. # noqa: E501 3259 3260 :param underline: The underline of this FormulaTab. # noqa: E501 3261 :type: str 3262 """ 3263 3264 self._underline = underline 3265 3266 @property 3267 def underline_metadata(self): 3268 """Gets the underline_metadata of this FormulaTab. # noqa: E501 3269 3270 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3271 3272 :return: The underline_metadata of this FormulaTab. # noqa: E501 3273 :rtype: PropertyMetadata 3274 """ 3275 return self._underline_metadata 3276 3277 @underline_metadata.setter 3278 def underline_metadata(self, underline_metadata): 3279 """Sets the underline_metadata of this FormulaTab. 3280 3281 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3282 3283 :param underline_metadata: The underline_metadata of this FormulaTab. # noqa: E501 3284 :type: PropertyMetadata 3285 """ 3286 3287 self._underline_metadata = underline_metadata 3288 3289 @property 3290 def validation_message(self): 3291 """Gets the validation_message of this FormulaTab. # noqa: E501 3292 3293 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3294 3295 :return: The validation_message of this FormulaTab. # noqa: E501 3296 :rtype: str 3297 """ 3298 return self._validation_message 3299 3300 @validation_message.setter 3301 def validation_message(self, validation_message): 3302 """Sets the validation_message of this FormulaTab. 3303 3304 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3305 3306 :param validation_message: The validation_message of this FormulaTab. # noqa: E501 3307 :type: str 3308 """ 3309 3310 self._validation_message = validation_message 3311 3312 @property 3313 def validation_message_metadata(self): 3314 """Gets the validation_message_metadata of this FormulaTab. # noqa: E501 3315 3316 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3317 3318 :return: The validation_message_metadata of this FormulaTab. # noqa: E501 3319 :rtype: PropertyMetadata 3320 """ 3321 return self._validation_message_metadata 3322 3323 @validation_message_metadata.setter 3324 def validation_message_metadata(self, validation_message_metadata): 3325 """Sets the validation_message_metadata of this FormulaTab. 3326 3327 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3328 3329 :param validation_message_metadata: The validation_message_metadata of this FormulaTab. # noqa: E501 3330 :type: PropertyMetadata 3331 """ 3332 3333 self._validation_message_metadata = validation_message_metadata 3334 3335 @property 3336 def validation_pattern(self): 3337 """Gets the validation_pattern of this FormulaTab. # noqa: E501 3338 3339 A regular expression used to validate input for the tab. # noqa: E501 3340 3341 :return: The validation_pattern of this FormulaTab. # noqa: E501 3342 :rtype: str 3343 """ 3344 return self._validation_pattern 3345 3346 @validation_pattern.setter 3347 def validation_pattern(self, validation_pattern): 3348 """Sets the validation_pattern of this FormulaTab. 3349 3350 A regular expression used to validate input for the tab. # noqa: E501 3351 3352 :param validation_pattern: The validation_pattern of this FormulaTab. # noqa: E501 3353 :type: str 3354 """ 3355 3356 self._validation_pattern = validation_pattern 3357 3358 @property 3359 def validation_pattern_metadata(self): 3360 """Gets the validation_pattern_metadata of this FormulaTab. # noqa: E501 3361 3362 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3363 3364 :return: The validation_pattern_metadata of this FormulaTab. # noqa: E501 3365 :rtype: PropertyMetadata 3366 """ 3367 return self._validation_pattern_metadata 3368 3369 @validation_pattern_metadata.setter 3370 def validation_pattern_metadata(self, validation_pattern_metadata): 3371 """Sets the validation_pattern_metadata of this FormulaTab. 3372 3373 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3374 3375 :param validation_pattern_metadata: The validation_pattern_metadata of this FormulaTab. # noqa: E501 3376 :type: PropertyMetadata 3377 """ 3378 3379 self._validation_pattern_metadata = validation_pattern_metadata 3380 3381 @property 3382 def value(self): 3383 """Gets the value of this FormulaTab. # noqa: E501 3384 3385 Specifies the value of the tab. # noqa: E501 3386 3387 :return: The value of this FormulaTab. # noqa: E501 3388 :rtype: str 3389 """ 3390 return self._value 3391 3392 @value.setter 3393 def value(self, value): 3394 """Sets the value of this FormulaTab. 3395 3396 Specifies the value of the tab. # noqa: E501 3397 3398 :param value: The value of this FormulaTab. # noqa: E501 3399 :type: str 3400 """ 3401 3402 self._value = value 3403 3404 @property 3405 def value_metadata(self): 3406 """Gets the value_metadata of this FormulaTab. # noqa: E501 3407 3408 Metadata that indicates whether the `value` property is editable. # noqa: E501 3409 3410 :return: The value_metadata of this FormulaTab. # noqa: E501 3411 :rtype: PropertyMetadata 3412 """ 3413 return self._value_metadata 3414 3415 @value_metadata.setter 3416 def value_metadata(self, value_metadata): 3417 """Sets the value_metadata of this FormulaTab. 3418 3419 Metadata that indicates whether the `value` property is editable. # noqa: E501 3420 3421 :param value_metadata: The value_metadata of this FormulaTab. # noqa: E501 3422 :type: PropertyMetadata 3423 """ 3424 3425 self._value_metadata = value_metadata 3426 3427 @property 3428 def warning_details(self): 3429 """Gets the warning_details of this FormulaTab. # noqa: E501 3430 3431 # noqa: E501 3432 3433 :return: The warning_details of this FormulaTab. # noqa: E501 3434 :rtype: ErrorDetails 3435 """ 3436 return self._warning_details 3437 3438 @warning_details.setter 3439 def warning_details(self, warning_details): 3440 """Sets the warning_details of this FormulaTab. 3441 3442 # noqa: E501 3443 3444 :param warning_details: The warning_details of this FormulaTab. # noqa: E501 3445 :type: ErrorDetails 3446 """ 3447 3448 self._warning_details = warning_details 3449 3450 @property 3451 def width(self): 3452 """Gets the width of this FormulaTab. # noqa: E501 3453 3454 Width of the tab in pixels. # noqa: E501 3455 3456 :return: The width of this FormulaTab. # noqa: E501 3457 :rtype: str 3458 """ 3459 return self._width 3460 3461 @width.setter 3462 def width(self, width): 3463 """Sets the width of this FormulaTab. 3464 3465 Width of the tab in pixels. # noqa: E501 3466 3467 :param width: The width of this FormulaTab. # noqa: E501 3468 :type: str 3469 """ 3470 3471 self._width = width 3472 3473 @property 3474 def width_metadata(self): 3475 """Gets the width_metadata of this FormulaTab. # noqa: E501 3476 3477 Metadata that indicates whether the `width` property is editable. # noqa: E501 3478 3479 :return: The width_metadata of this FormulaTab. # noqa: E501 3480 :rtype: PropertyMetadata 3481 """ 3482 return self._width_metadata 3483 3484 @width_metadata.setter 3485 def width_metadata(self, width_metadata): 3486 """Sets the width_metadata of this FormulaTab. 3487 3488 Metadata that indicates whether the `width` property is editable. # noqa: E501 3489 3490 :param width_metadata: The width_metadata of this FormulaTab. # noqa: E501 3491 :type: PropertyMetadata 3492 """ 3493 3494 self._width_metadata = width_metadata 3495 3496 @property 3497 def x_position(self): 3498 """Gets the x_position of this FormulaTab. # noqa: E501 3499 3500 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3501 3502 :return: The x_position of this FormulaTab. # noqa: E501 3503 :rtype: str 3504 """ 3505 return self._x_position 3506 3507 @x_position.setter 3508 def x_position(self, x_position): 3509 """Sets the x_position of this FormulaTab. 3510 3511 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3512 3513 :param x_position: The x_position of this FormulaTab. # noqa: E501 3514 :type: str 3515 """ 3516 3517 self._x_position = x_position 3518 3519 @property 3520 def x_position_metadata(self): 3521 """Gets the x_position_metadata of this FormulaTab. # noqa: E501 3522 3523 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3524 3525 :return: The x_position_metadata of this FormulaTab. # noqa: E501 3526 :rtype: PropertyMetadata 3527 """ 3528 return self._x_position_metadata 3529 3530 @x_position_metadata.setter 3531 def x_position_metadata(self, x_position_metadata): 3532 """Sets the x_position_metadata of this FormulaTab. 3533 3534 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3535 3536 :param x_position_metadata: The x_position_metadata of this FormulaTab. # noqa: E501 3537 :type: PropertyMetadata 3538 """ 3539 3540 self._x_position_metadata = x_position_metadata 3541 3542 @property 3543 def y_position(self): 3544 """Gets the y_position of this FormulaTab. # noqa: E501 3545 3546 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3547 3548 :return: The y_position of this FormulaTab. # noqa: E501 3549 :rtype: str 3550 """ 3551 return self._y_position 3552 3553 @y_position.setter 3554 def y_position(self, y_position): 3555 """Sets the y_position of this FormulaTab. 3556 3557 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3558 3559 :param y_position: The y_position of this FormulaTab. # noqa: E501 3560 :type: str 3561 """ 3562 3563 self._y_position = y_position 3564 3565 @property 3566 def y_position_metadata(self): 3567 """Gets the y_position_metadata of this FormulaTab. # noqa: E501 3568 3569 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3570 3571 :return: The y_position_metadata of this FormulaTab. # noqa: E501 3572 :rtype: PropertyMetadata 3573 """ 3574 return self._y_position_metadata 3575 3576 @y_position_metadata.setter 3577 def y_position_metadata(self, y_position_metadata): 3578 """Sets the y_position_metadata of this FormulaTab. 3579 3580 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3581 3582 :param y_position_metadata: The y_position_metadata of this FormulaTab. # noqa: E501 3583 :type: PropertyMetadata 3584 """ 3585 3586 self._y_position_metadata = y_position_metadata 3587 3588 def to_dict(self): 3589 """Returns the model properties as a dict""" 3590 result = {} 3591 3592 for attr, _ in six.iteritems(self.swagger_types): 3593 value = getattr(self, attr) 3594 if isinstance(value, list): 3595 result[attr] = list(map( 3596 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3597 value 3598 )) 3599 elif hasattr(value, "to_dict"): 3600 result[attr] = value.to_dict() 3601 elif isinstance(value, dict): 3602 result[attr] = dict(map( 3603 lambda item: (item[0], item[1].to_dict()) 3604 if hasattr(item[1], "to_dict") else item, 3605 value.items() 3606 )) 3607 else: 3608 result[attr] = value 3609 if issubclass(FormulaTab, dict): 3610 for key, value in self.items(): 3611 result[key] = value 3612 3613 return result 3614 3615 def to_str(self): 3616 """Returns the string representation of the model""" 3617 return pprint.pformat(self.to_dict()) 3618 3619 def __repr__(self): 3620 """For `print` and `pprint`""" 3621 return self.to_str() 3622 3623 def __eq__(self, other): 3624 """Returns true if both objects are equal""" 3625 if not isinstance(other, FormulaTab): 3626 return False 3627 3628 return self.to_dict() == other.to_dict() 3629 3630 def __ne__(self, other): 3631 """Returns true if both objects are not equal""" 3632 if not isinstance(other, FormulaTab): 3633 return True 3634 3635 return self.to_dict() != other.to_dict()
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
FormulaTab(_configuration=None, **kwargs)
304 def __init__(self, _configuration=None, **kwargs): # noqa: E501 305 """FormulaTab - a model defined in Swagger""" # noqa: E501 306 if _configuration is None: 307 _configuration = Configuration() 308 self._configuration = _configuration 309 310 self._agreement_attribute = None 311 self._agreement_attribute_locked = None 312 self._anchor_allow_white_space_in_characters = None 313 self._anchor_allow_white_space_in_characters_metadata = None 314 self._anchor_case_sensitive = None 315 self._anchor_case_sensitive_metadata = None 316 self._anchor_horizontal_alignment = None 317 self._anchor_horizontal_alignment_metadata = None 318 self._anchor_ignore_if_not_present = None 319 self._anchor_ignore_if_not_present_metadata = None 320 self._anchor_match_whole_word = None 321 self._anchor_match_whole_word_metadata = None 322 self._anchor_string = None 323 self._anchor_string_metadata = None 324 self._anchor_tab_processor_version = None 325 self._anchor_tab_processor_version_metadata = None 326 self._anchor_units = None 327 self._anchor_units_metadata = None 328 self._anchor_x_offset = None 329 self._anchor_x_offset_metadata = None 330 self._anchor_y_offset = None 331 self._anchor_y_offset_metadata = None 332 self._bold = None 333 self._bold_metadata = None 334 self._caption = None 335 self._caption_metadata = None 336 self._conceal_value_on_document = None 337 self._conceal_value_on_document_metadata = None 338 self._conditional_parent_label = None 339 self._conditional_parent_label_metadata = None 340 self._conditional_parent_value = None 341 self._conditional_parent_value_metadata = None 342 self._connected_object_details = None 343 self._custom_tab_id = None 344 self._custom_tab_id_metadata = None 345 self._disable_auto_size = None 346 self._disable_auto_size_metadata = None 347 self._document_id = None 348 self._document_id_metadata = None 349 self._error_details = None 350 self._extension_data = None 351 self._font = None 352 self._font_color = None 353 self._font_color_metadata = None 354 self._font_metadata = None 355 self._font_size = None 356 self._font_size_metadata = None 357 self._form_order = None 358 self._form_order_metadata = None 359 self._form_page_label = None 360 self._form_page_label_metadata = None 361 self._form_page_number = None 362 self._form_page_number_metadata = None 363 self._formula = None 364 self._formula_metadata = None 365 self._height = None 366 self._height_metadata = None 367 self._hidden = None 368 self._hidden_metadata = None 369 self._is_payment_amount = None 370 self._is_payment_amount_metadata = None 371 self._italic = None 372 self._italic_metadata = None 373 self._locale_policy = None 374 self._locked = None 375 self._locked_metadata = None 376 self._max_length = None 377 self._max_length_metadata = None 378 self._merge_field = None 379 self._merge_field_xml = None 380 self._name = None 381 self._name_metadata = None 382 self._original_value = None 383 self._original_value_metadata = None 384 self._page_number = None 385 self._page_number_metadata = None 386 self._payment_details = None 387 self._recipient_id = None 388 self._recipient_id_guid = None 389 self._recipient_id_guid_metadata = None 390 self._recipient_id_metadata = None 391 self._require_all = None 392 self._require_all_metadata = None 393 self._required = None 394 self._required_metadata = None 395 self._require_initial_on_shared_change = None 396 self._require_initial_on_shared_change_metadata = None 397 self._round_decimal_places = None 398 self._round_decimal_places_metadata = None 399 self._sender_required = None 400 self._sender_required_metadata = None 401 self._shared = None 402 self._shared_metadata = None 403 self._share_to_recipients = None 404 self._share_to_recipients_metadata = None 405 self._smart_contract_information = None 406 self._source = None 407 self._status = None 408 self._status_metadata = None 409 self._tab_fully_qualified_path = None 410 self._tab_group_labels = None 411 self._tab_group_labels_metadata = None 412 self._tab_id = None 413 self._tab_id_metadata = None 414 self._tab_label = None 415 self._tab_label_metadata = None 416 self._tab_order = None 417 self._tab_order_metadata = None 418 self._tab_type = None 419 self._tab_type_metadata = None 420 self._template_locked = None 421 self._template_locked_metadata = None 422 self._template_required = None 423 self._template_required_metadata = None 424 self._tooltip = None 425 self._tool_tip_metadata = None 426 self._underline = None 427 self._underline_metadata = None 428 self._validation_message = None 429 self._validation_message_metadata = None 430 self._validation_pattern = None 431 self._validation_pattern_metadata = None 432 self._value = None 433 self._value_metadata = None 434 self._warning_details = None 435 self._width = None 436 self._width_metadata = None 437 self._x_position = None 438 self._x_position_metadata = None 439 self._y_position = None 440 self._y_position_metadata = None 441 self.discriminator = None 442 443 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 444 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 445 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 446 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 447 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 448 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 449 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 450 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 451 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 452 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 453 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 454 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 455 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 456 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 457 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 458 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 459 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 460 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 461 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 462 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 463 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 464 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 465 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 466 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 467 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 468 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 469 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 470 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 471 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 472 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 473 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 474 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 475 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 476 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 477 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 478 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 479 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 480 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 481 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 482 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 483 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 484 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 485 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 486 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 487 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 488 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 489 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 490 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 491 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 492 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 493 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 494 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 495 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 496 setattr(self, "_{}".format('formula'), kwargs.get('formula', None)) 497 setattr(self, "_{}".format('formula_metadata'), kwargs.get('formula_metadata', None)) 498 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 499 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 500 setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None)) 501 setattr(self, "_{}".format('hidden_metadata'), kwargs.get('hidden_metadata', None)) 502 setattr(self, "_{}".format('is_payment_amount'), kwargs.get('is_payment_amount', None)) 503 setattr(self, "_{}".format('is_payment_amount_metadata'), kwargs.get('is_payment_amount_metadata', None)) 504 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 505 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 506 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 507 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 508 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 509 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 510 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 511 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 512 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 513 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 514 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 515 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 516 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 517 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 518 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 519 setattr(self, "_{}".format('payment_details'), kwargs.get('payment_details', None)) 520 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 521 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 522 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 523 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 524 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 525 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 526 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 527 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 528 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 529 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 530 setattr(self, "_{}".format('round_decimal_places'), kwargs.get('round_decimal_places', None)) 531 setattr(self, "_{}".format('round_decimal_places_metadata'), kwargs.get('round_decimal_places_metadata', None)) 532 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 533 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 534 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 535 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 536 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 537 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 538 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 539 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 540 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 541 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 542 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 543 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 544 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 545 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 546 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 547 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 548 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 549 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 550 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 551 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 552 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 553 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 554 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 555 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 556 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 557 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 558 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 559 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 560 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 561 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 562 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 563 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 564 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 565 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 566 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 567 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 568 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 569 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 570 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 571 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 572 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 573 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None))
FormulaTab - a model defined in Swagger
swagger_types = {'agreement_attribute': 'str', 'agreement_attribute_locked': 'str', 'anchor_allow_white_space_in_characters': 'str', 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 'anchor_case_sensitive': 'str', 'anchor_case_sensitive_metadata': 'PropertyMetadata', 'anchor_horizontal_alignment': 'str', 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 'anchor_ignore_if_not_present': 'str', 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 'anchor_match_whole_word': 'str', 'anchor_match_whole_word_metadata': 'PropertyMetadata', 'anchor_string': 'str', 'anchor_string_metadata': 'PropertyMetadata', 'anchor_tab_processor_version': 'str', 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 'anchor_units': 'str', 'anchor_units_metadata': 'PropertyMetadata', 'anchor_x_offset': 'str', 'anchor_x_offset_metadata': 'PropertyMetadata', 'anchor_y_offset': 'str', 'anchor_y_offset_metadata': 'PropertyMetadata', 'bold': 'str', 'bold_metadata': 'PropertyMetadata', 'caption': 'str', 'caption_metadata': 'PropertyMetadata', 'conceal_value_on_document': 'str', 'conceal_value_on_document_metadata': 'PropertyMetadata', 'conditional_parent_label': 'str', 'conditional_parent_label_metadata': 'PropertyMetadata', 'conditional_parent_value': 'str', 'conditional_parent_value_metadata': 'PropertyMetadata', 'connected_object_details': 'ConnectedObjectDetails', 'custom_tab_id': 'str', 'custom_tab_id_metadata': 'PropertyMetadata', 'disable_auto_size': 'str', 'disable_auto_size_metadata': 'PropertyMetadata', 'document_id': 'str', 'document_id_metadata': 'PropertyMetadata', 'error_details': 'ErrorDetails', 'extension_data': 'ExtensionData', 'font': 'str', 'font_color': 'str', 'font_color_metadata': 'PropertyMetadata', 'font_metadata': 'PropertyMetadata', 'font_size': 'str', 'font_size_metadata': 'PropertyMetadata', 'form_order': 'str', 'form_order_metadata': 'PropertyMetadata', 'form_page_label': 'str', 'form_page_label_metadata': 'PropertyMetadata', 'form_page_number': 'str', 'form_page_number_metadata': 'PropertyMetadata', 'formula': 'str', 'formula_metadata': 'PropertyMetadata', 'height': 'str', 'height_metadata': 'PropertyMetadata', 'hidden': 'str', 'hidden_metadata': 'PropertyMetadata', 'is_payment_amount': 'str', 'is_payment_amount_metadata': 'PropertyMetadata', 'italic': 'str', 'italic_metadata': 'PropertyMetadata', 'locale_policy': 'LocalePolicyTab', 'locked': 'str', 'locked_metadata': 'PropertyMetadata', 'max_length': 'str', 'max_length_metadata': 'PropertyMetadata', 'merge_field': 'MergeField', 'merge_field_xml': 'str', 'name': 'str', 'name_metadata': 'PropertyMetadata', 'original_value': 'str', 'original_value_metadata': 'PropertyMetadata', 'page_number': 'str', 'page_number_metadata': 'PropertyMetadata', 'payment_details': 'PaymentDetails', 'recipient_id': 'str', 'recipient_id_guid': 'str', 'recipient_id_guid_metadata': 'PropertyMetadata', 'recipient_id_metadata': 'PropertyMetadata', 'require_all': 'str', 'require_all_metadata': 'PropertyMetadata', 'required': 'str', 'required_metadata': 'PropertyMetadata', 'require_initial_on_shared_change': 'str', 'require_initial_on_shared_change_metadata': 'PropertyMetadata', 'round_decimal_places': 'str', 'round_decimal_places_metadata': 'PropertyMetadata', 'sender_required': 'str', 'sender_required_metadata': 'PropertyMetadata', 'shared': 'str', 'shared_metadata': 'PropertyMetadata', 'share_to_recipients': 'str', 'share_to_recipients_metadata': 'PropertyMetadata', 'smart_contract_information': 'SmartContractInformation', 'source': 'str', 'status': 'str', 'status_metadata': 'PropertyMetadata', 'tab_fully_qualified_path': 'str', 'tab_group_labels': 'list[str]', 'tab_group_labels_metadata': 'PropertyMetadata', 'tab_id': 'str', 'tab_id_metadata': 'PropertyMetadata', 'tab_label': 'str', 'tab_label_metadata': 'PropertyMetadata', 'tab_order': 'str', 'tab_order_metadata': 'PropertyMetadata', 'tab_type': 'str', 'tab_type_metadata': 'PropertyMetadata', 'template_locked': 'str', 'template_locked_metadata': 'PropertyMetadata', 'template_required': 'str', 'template_required_metadata': 'PropertyMetadata', 'tooltip': 'str', 'tool_tip_metadata': 'PropertyMetadata', 'underline': 'str', 'underline_metadata': 'PropertyMetadata', 'validation_message': 'str', 'validation_message_metadata': 'PropertyMetadata', 'validation_pattern': 'str', 'validation_pattern_metadata': 'PropertyMetadata', 'value': 'str', 'value_metadata': 'PropertyMetadata', 'warning_details': 'ErrorDetails', 'width': 'str', 'width_metadata': 'PropertyMetadata', 'x_position': 'str', 'x_position_metadata': 'PropertyMetadata', 'y_position': 'str', 'y_position_metadata': 'PropertyMetadata'}
attribute_map = {'agreement_attribute': 'agreementAttribute', 'agreement_attribute_locked': 'agreementAttributeLocked', 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive': 'anchorCaseSensitive', 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word': 'anchorMatchWholeWord', 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 'anchor_string': 'anchorString', 'anchor_string_metadata': 'anchorStringMetadata', 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 'anchor_units': 'anchorUnits', 'anchor_units_metadata': 'anchorUnitsMetadata', 'anchor_x_offset': 'anchorXOffset', 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 'anchor_y_offset': 'anchorYOffset', 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 'bold': 'bold', 'bold_metadata': 'boldMetadata', 'caption': 'caption', 'caption_metadata': 'captionMetadata', 'conceal_value_on_document': 'concealValueOnDocument', 'conceal_value_on_document_metadata': 'concealValueOnDocumentMetadata', 'conditional_parent_label': 'conditionalParentLabel', 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 'conditional_parent_value': 'conditionalParentValue', 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 'connected_object_details': 'connectedObjectDetails', 'custom_tab_id': 'customTabId', 'custom_tab_id_metadata': 'customTabIdMetadata', 'disable_auto_size': 'disableAutoSize', 'disable_auto_size_metadata': 'disableAutoSizeMetadata', 'document_id': 'documentId', 'document_id_metadata': 'documentIdMetadata', 'error_details': 'errorDetails', 'extension_data': 'extensionData', 'font': 'font', 'font_color': 'fontColor', 'font_color_metadata': 'fontColorMetadata', 'font_metadata': 'fontMetadata', 'font_size': 'fontSize', 'font_size_metadata': 'fontSizeMetadata', 'form_order': 'formOrder', 'form_order_metadata': 'formOrderMetadata', 'form_page_label': 'formPageLabel', 'form_page_label_metadata': 'formPageLabelMetadata', 'form_page_number': 'formPageNumber', 'form_page_number_metadata': 'formPageNumberMetadata', 'formula': 'formula', 'formula_metadata': 'formulaMetadata', 'height': 'height', 'height_metadata': 'heightMetadata', 'hidden': 'hidden', 'hidden_metadata': 'hiddenMetadata', 'is_payment_amount': 'isPaymentAmount', 'is_payment_amount_metadata': 'isPaymentAmountMetadata', 'italic': 'italic', 'italic_metadata': 'italicMetadata', 'locale_policy': 'localePolicy', 'locked': 'locked', 'locked_metadata': 'lockedMetadata', 'max_length': 'maxLength', 'max_length_metadata': 'maxLengthMetadata', 'merge_field': 'mergeField', 'merge_field_xml': 'mergeFieldXml', 'name': 'name', 'name_metadata': 'nameMetadata', 'original_value': 'originalValue', 'original_value_metadata': 'originalValueMetadata', 'page_number': 'pageNumber', 'page_number_metadata': 'pageNumberMetadata', 'payment_details': 'paymentDetails', 'recipient_id': 'recipientId', 'recipient_id_guid': 'recipientIdGuid', 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 'recipient_id_metadata': 'recipientIdMetadata', 'require_all': 'requireAll', 'require_all_metadata': 'requireAllMetadata', 'required': 'required', 'required_metadata': 'requiredMetadata', 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 'require_initial_on_shared_change_metadata': 'requireInitialOnSharedChangeMetadata', 'round_decimal_places': 'roundDecimalPlaces', 'round_decimal_places_metadata': 'roundDecimalPlacesMetadata', 'sender_required': 'senderRequired', 'sender_required_metadata': 'senderRequiredMetadata', 'shared': 'shared', 'shared_metadata': 'sharedMetadata', 'share_to_recipients': 'shareToRecipients', 'share_to_recipients_metadata': 'shareToRecipientsMetadata', 'smart_contract_information': 'smartContractInformation', 'source': 'source', 'status': 'status', 'status_metadata': 'statusMetadata', 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 'tab_group_labels': 'tabGroupLabels', 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 'tab_id': 'tabId', 'tab_id_metadata': 'tabIdMetadata', 'tab_label': 'tabLabel', 'tab_label_metadata': 'tabLabelMetadata', 'tab_order': 'tabOrder', 'tab_order_metadata': 'tabOrderMetadata', 'tab_type': 'tabType', 'tab_type_metadata': 'tabTypeMetadata', 'template_locked': 'templateLocked', 'template_locked_metadata': 'templateLockedMetadata', 'template_required': 'templateRequired', 'template_required_metadata': 'templateRequiredMetadata', 'tooltip': 'tooltip', 'tool_tip_metadata': 'toolTipMetadata', 'underline': 'underline', 'underline_metadata': 'underlineMetadata', 'validation_message': 'validationMessage', 'validation_message_metadata': 'validationMessageMetadata', 'validation_pattern': 'validationPattern', 'validation_pattern_metadata': 'validationPatternMetadata', 'value': 'value', 'value_metadata': 'valueMetadata', 'warning_details': 'warningDetails', 'width': 'width', 'width_metadata': 'widthMetadata', 'x_position': 'xPosition', 'x_position_metadata': 'xPositionMetadata', 'y_position': 'yPosition', 'y_position_metadata': 'yPositionMetadata'}
agreement_attribute
Gets the agreement_attribute of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The agreement_attribute of this FormulaTab. # noqa: E501
agreement_attribute_locked
Gets the agreement_attribute_locked of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The agreement_attribute_locked of this FormulaTab. # noqa: E501
anchor_allow_white_space_in_characters
Gets the anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501
anchor_allow_white_space_in_characters_metadata
Gets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorAllowWhiteSpaceInCharacters property is editable. # noqa: E501
Returns
The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501
anchor_case_sensitive
Gets the anchor_case_sensitive of this FormulaTab. # noqa: E501
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true. # noqa: E501
Returns
The anchor_case_sensitive of this FormulaTab. # noqa: E501
anchor_case_sensitive_metadata
Gets the anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorCaseSensitive property is editable. # noqa: E501
Returns
The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501
anchor_horizontal_alignment
Gets the anchor_horizontal_alignment of this FormulaTab. # noqa: E501
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left. # noqa: E501
Returns
The anchor_horizontal_alignment of this FormulaTab. # noqa: E501
anchor_horizontal_alignment_metadata
Gets the anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorHorizontalAlignment property is editable. # noqa: E501
Returns
The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501
anchor_ignore_if_not_present
Gets the anchor_ignore_if_not_present of this FormulaTab. # noqa: E501
When set to true, this tab is ignored if anchorString is not found in the document. # noqa: E501
Returns
The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501
anchor_ignore_if_not_present_metadata
Gets the anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable. # noqa: E501
Returns
The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501
anchor_match_whole_word
Gets the anchor_match_whole_word of this FormulaTab. # noqa: E501
When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true. # noqa: E501
Returns
The anchor_match_whole_word of this FormulaTab. # noqa: E501
anchor_match_whole_word_metadata
Gets the anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorMatchWholeWord property is editable. # noqa: E501
Returns
The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501
anchor_string
Gets the anchor_string of this FormulaTab. # noqa: E501
Anchor text information for a radio button. # noqa: E501
Returns
The anchor_string of this FormulaTab. # noqa: E501
anchor_string_metadata
Gets the anchor_string_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorString property is editable. # noqa: E501
Returns
The anchor_string_metadata of this FormulaTab. # noqa: E501
anchor_tab_processor_version
Gets the anchor_tab_processor_version of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The anchor_tab_processor_version of this FormulaTab. # noqa: E501
anchor_tab_processor_version_metadata
Gets the anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501
anchor_units
Gets the anchor_units of this FormulaTab. # noqa: E501
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501
Returns
The anchor_units of this FormulaTab. # noqa: E501
anchor_units_metadata
Gets the anchor_units_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorUnits property is editable. # noqa: E501
Returns
The anchor_units_metadata of this FormulaTab. # noqa: E501
anchor_x_offset
Gets the anchor_x_offset of this FormulaTab. # noqa: E501
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501
Returns
The anchor_x_offset of this FormulaTab. # noqa: E501
anchor_x_offset_metadata
Gets the anchor_x_offset_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorXOffset property is editable. # noqa: E501
Returns
The anchor_x_offset_metadata of this FormulaTab. # noqa: E501
anchor_y_offset
Gets the anchor_y_offset of this FormulaTab. # noqa: E501
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501
Returns
The anchor_y_offset of this FormulaTab. # noqa: E501
anchor_y_offset_metadata
Gets the anchor_y_offset_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorYOffset property is editable. # noqa: E501
Returns
The anchor_y_offset_metadata of this FormulaTab. # noqa: E501
bold
Gets the bold of this FormulaTab. # noqa: E501
When set to true, the information in the tab is bold. # noqa: E501
Returns
The bold of this FormulaTab. # noqa: E501
bold_metadata
Gets the bold_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the bold property is editable. # noqa: E501
Returns
The bold_metadata of this FormulaTab. # noqa: E501
caption
Gets the caption of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The caption of this FormulaTab. # noqa: E501
caption_metadata
Gets the caption_metadata of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The caption_metadata of this FormulaTab. # noqa: E501
conceal_value_on_document
Gets the conceal_value_on_document of this FormulaTab. # noqa: E501
When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501
Returns
The conceal_value_on_document of this FormulaTab. # noqa: E501
conceal_value_on_document_metadata
Gets the conceal_value_on_document_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the concealValueOnDocument property is editable. # noqa: E501
Returns
The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501
conditional_parent_label
Gets the conditional_parent_label of this FormulaTab. # noqa: E501
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501
Returns
The conditional_parent_label of this FormulaTab. # noqa: E501
conditional_parent_label_metadata
Gets the conditional_parent_label_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the conditionalParentLabel property is editable. # noqa: E501
Returns
The conditional_parent_label_metadata of this FormulaTab. # noqa: E501
conditional_parent_value
Gets the conditional_parent_value of this FormulaTab. # noqa: E501
For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. # noqa: E501
Returns
The conditional_parent_value of this FormulaTab. # noqa: E501
conditional_parent_value_metadata
Gets the conditional_parent_value_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the conditionalParentValue property is editable. # noqa: E501
Returns
The conditional_parent_value_metadata of this FormulaTab. # noqa: E501
connected_object_details
Gets the connected_object_details of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The connected_object_details of this FormulaTab. # noqa: E501
custom_tab_id
Gets the custom_tab_id of this FormulaTab. # noqa: E501
The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. # noqa: E501
Returns
The custom_tab_id of this FormulaTab. # noqa: E501
custom_tab_id_metadata
Gets the custom_tab_id_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the customTabId property is editable. # noqa: E501
Returns
The custom_tab_id_metadata of this FormulaTab. # noqa: E501
disable_auto_size
Gets the disable_auto_size of this FormulaTab. # noqa: E501
When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501
Returns
The disable_auto_size of this FormulaTab. # noqa: E501
disable_auto_size_metadata
Gets the disable_auto_size_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the disableAutoSize property is editable. # noqa: E501
Returns
The disable_auto_size_metadata of this FormulaTab. # noqa: E501
document_id
Gets the document_id of this FormulaTab. # noqa: E501
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501
Returns
The document_id of this FormulaTab. # noqa: E501
document_id_metadata
Gets the document_id_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the documentId property is editable. # noqa: E501
Returns
The document_id_metadata of this FormulaTab. # noqa: E501
error_details
Gets the error_details of this FormulaTab. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this FormulaTab. # noqa: E501
extension_data
Gets the extension_data of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The extension_data of this FormulaTab. # noqa: E501
font
Gets the font of this FormulaTab. # noqa: E501
The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. # noqa: E501
Returns
The font of this FormulaTab. # noqa: E501
font_color
Gets the font_color of this FormulaTab. # noqa: E501
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. # noqa: E501
Returns
The font_color of this FormulaTab. # noqa: E501
font_color_metadata
Gets the font_color_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the fontColor property is editable. # noqa: E501
Returns
The font_color_metadata of this FormulaTab. # noqa: E501
font_metadata
Gets the font_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the font property is editable. # noqa: E501
Returns
The font_metadata of this FormulaTab. # noqa: E501
font_size
Gets the font_size of this FormulaTab. # noqa: E501
The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. # noqa: E501
Returns
The font_size of this FormulaTab. # noqa: E501
font_size_metadata
Gets the font_size_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the fontSize property is editable. # noqa: E501
Returns
The font_size_metadata of this FormulaTab. # noqa: E501
form_order
Gets the form_order of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The form_order of this FormulaTab. # noqa: E501
form_order_metadata
Gets the form_order_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the formOrder property is editable. # noqa: E501
Returns
The form_order_metadata of this FormulaTab. # noqa: E501
form_page_label
Gets the form_page_label of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The form_page_label of this FormulaTab. # noqa: E501
form_page_label_metadata
Gets the form_page_label_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the formPageLabel property is editable. # noqa: E501
Returns
The form_page_label_metadata of this FormulaTab. # noqa: E501
form_page_number
Gets the form_page_number of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The form_page_number of this FormulaTab. # noqa: E501
form_page_number_metadata
Gets the form_page_number_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the fromPageNumber property is editable. # noqa: E501
Returns
The form_page_number_metadata of this FormulaTab. # noqa: E501
formula
Gets the formula of this FormulaTab. # noqa: E501
The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. Example: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501
Returns
The formula of this FormulaTab. # noqa: E501
formula_metadata
Gets the formula_metadata of this FormulaTab. # noqa: E501
Metadata indicating if the sender can edit the formula property. # noqa: E501
Returns
The formula_metadata of this FormulaTab. # noqa: E501
height
Gets the height of this FormulaTab. # noqa: E501
Height of the tab in pixels. # noqa: E501
Returns
The height of this FormulaTab. # noqa: E501
height_metadata
Gets the height_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the height property is editable. # noqa: E501
Returns
The height_metadata of this FormulaTab. # noqa: E501
is_payment_amount
Gets the is_payment_amount of this FormulaTab. # noqa: E501
When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501
Returns
The is_payment_amount of this FormulaTab. # noqa: E501
is_payment_amount_metadata
Gets the is_payment_amount_metadata of this FormulaTab. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The is_payment_amount_metadata of this FormulaTab. # noqa: E501
italic
Gets the italic of this FormulaTab. # noqa: E501
When set to true, the information in the tab is italic. # noqa: E501
Returns
The italic of this FormulaTab. # noqa: E501
italic_metadata
Gets the italic_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the italic property is editable. # noqa: E501
Returns
The italic_metadata of this FormulaTab. # noqa: E501
locale_policy
Gets the locale_policy of this FormulaTab. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The locale_policy of this FormulaTab. # noqa: E501
locked
Gets the locked of this FormulaTab. # noqa: E501
When set to true, the signer cannot change the data of the custom tab. # noqa: E501
Returns
The locked of this FormulaTab. # noqa: E501
locked_metadata
Gets the locked_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the locked property is editable. # noqa: E501
Returns
The locked_metadata of this FormulaTab. # noqa: E501
max_length
Gets the max_length of this FormulaTab. # noqa: E501
An optional value that describes the maximum length of the property when the property is a string. # noqa: E501
Returns
The max_length of this FormulaTab. # noqa: E501
max_length_metadata
Gets the max_length_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the maxLength property is editable. # noqa: E501
Returns
The max_length_metadata of this FormulaTab. # noqa: E501
merge_field
Gets the merge_field of this FormulaTab. # noqa: E501
Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501
Returns
The merge_field of this FormulaTab. # noqa: E501
merge_field_xml
Gets the merge_field_xml of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The merge_field_xml of this FormulaTab. # noqa: E501
name
Gets the name of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The name of this FormulaTab. # noqa: E501
name_metadata
Gets the name_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the name property is editable. This property is read-only. # noqa: E501
Returns
The name_metadata of this FormulaTab. # noqa: E501
original_value
Gets the original_value of this FormulaTab. # noqa: E501
The initial value of the tab when it was sent to the recipient. # noqa: E501
Returns
The original_value of this FormulaTab. # noqa: E501
original_value_metadata
Gets the original_value_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the originalValue property is editable. # noqa: E501
Returns
The original_value_metadata of this FormulaTab. # noqa: E501
page_number
Gets the page_number of this FormulaTab. # noqa: E501
Specifies the page number on which the tab is located. # noqa: E501
Returns
The page_number of this FormulaTab. # noqa: E501
page_number_metadata
Gets the page_number_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the pageNumber property is editable. # noqa: E501
Returns
The page_number_metadata of this FormulaTab. # noqa: E501
payment_details
Gets the payment_details of this FormulaTab. # noqa: E501
This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501
Returns
The payment_details of this FormulaTab. # noqa: E501
recipient_id
Gets the recipient_id of this FormulaTab. # noqa: E501
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501
Returns
The recipient_id of this FormulaTab. # noqa: E501
recipient_id_guid
Gets the recipient_id_guid of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this FormulaTab. # noqa: E501
recipient_id_guid_metadata
Gets the recipient_id_guid_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the recipientIdGuid property is editable. # noqa: E501
Returns
The recipient_id_guid_metadata of this FormulaTab. # noqa: E501
recipient_id_metadata
Gets the recipient_id_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the recipientId property is editable. # noqa: E501
Returns
The recipient_id_metadata of this FormulaTab. # noqa: E501
require_all
Gets the require_all of this FormulaTab. # noqa: E501
When set to true and shared is true, information must be entered in this field to complete the envelope. # noqa: E501
Returns
The require_all of this FormulaTab. # noqa: E501
require_all_metadata
Gets the require_all_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the requireAll property is editable. # noqa: E501
Returns
The require_all_metadata of this FormulaTab. # noqa: E501
required
Gets the required of this FormulaTab. # noqa: E501
When set to true, the signer is required to fill out this tab # noqa: E501
Returns
The required of this FormulaTab. # noqa: E501
required_metadata
Gets the required_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the required property is editable. # noqa: E501
Returns
The required_metadata of this FormulaTab. # noqa: E501
round_decimal_places
Gets the round_decimal_places of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The round_decimal_places of this FormulaTab. # noqa: E501
round_decimal_places_metadata
Gets the round_decimal_places_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the roundDecimalPlaces property is editable. # noqa: E501
Returns
The round_decimal_places_metadata of this FormulaTab. # noqa: E501
sender_required
Gets the sender_required of this FormulaTab. # noqa: E501
When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a senderRequired value of true cannot be deleted from an envelope. # noqa: E501
Returns
The sender_required of this FormulaTab. # noqa: E501
sender_required_metadata
Gets the sender_required_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the senderRequired property is editable. # noqa: E501
Returns
The sender_required_metadata of this FormulaTab. # noqa: E501
smart_contract_information
Gets the smart_contract_information of this FormulaTab. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The smart_contract_information of this FormulaTab. # noqa: E501
source
Gets the source of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The source of this FormulaTab. # noqa: E501
status
Gets the status of this FormulaTab. # noqa: E501
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
Returns
The status of this FormulaTab. # noqa: E501
status_metadata
Gets the status_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the status property is editable. # noqa: E501
Returns
The status_metadata of this FormulaTab. # noqa: E501
tab_fully_qualified_path
Gets the tab_fully_qualified_path of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tab_fully_qualified_path of this FormulaTab. # noqa: E501
tab_group_labels
Gets the tab_group_labels of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tab_group_labels of this FormulaTab. # noqa: E501
tab_group_labels_metadata
Gets the tab_group_labels_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabGroupLabels property is editable. # noqa: E501
Returns
The tab_group_labels_metadata of this FormulaTab. # noqa: E501
tab_id
Gets the tab_id of this FormulaTab. # noqa: E501
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501
Returns
The tab_id of this FormulaTab. # noqa: E501
tab_id_metadata
Gets the tab_id_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabId property is editable. # noqa: E501
Returns
The tab_id_metadata of this FormulaTab. # noqa: E501
tab_label
Gets the tab_label of this FormulaTab. # noqa: E501
The label string associated with the tab. # noqa: E501
Returns
The tab_label of this FormulaTab. # noqa: E501
tab_label_metadata
Gets the tab_label_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabLabel property is editable. # noqa: E501
Returns
The tab_label_metadata of this FormulaTab. # noqa: E501
tab_order
Gets the tab_order of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tab_order of this FormulaTab. # noqa: E501
tab_order_metadata
Gets the tab_order_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabOrder property is editable. # noqa: E501
Returns
The tab_order_metadata of this FormulaTab. # noqa: E501
tab_type
Gets the tab_type of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tab_type of this FormulaTab. # noqa: E501
tab_type_metadata
Gets the tab_type_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabType property is editable. # noqa: E501
Returns
The tab_type_metadata of this FormulaTab. # noqa: E501
template_locked
Gets the template_locked of this FormulaTab. # noqa: E501
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_locked of this FormulaTab. # noqa: E501
template_locked_metadata
Gets the template_locked_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the templateLocked property is editable. # noqa: E501
Returns
The template_locked_metadata of this FormulaTab. # noqa: E501
template_required
Gets the template_required of this FormulaTab. # noqa: E501
When set to true, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_required of this FormulaTab. # noqa: E501
template_required_metadata
Gets the template_required_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the templateRequired property is editable. # noqa: E501
Returns
The template_required_metadata of this FormulaTab. # noqa: E501
tooltip
Gets the tooltip of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tooltip of this FormulaTab. # noqa: E501
tool_tip_metadata
Gets the tool_tip_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the toolTip property is editable. # noqa: E501
Returns
The tool_tip_metadata of this FormulaTab. # noqa: E501
underline
Gets the underline of this FormulaTab. # noqa: E501
When set to true, the information in the tab is underlined. # noqa: E501
Returns
The underline of this FormulaTab. # noqa: E501
underline_metadata
Gets the underline_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the underline property is editable. # noqa: E501
Returns
The underline_metadata of this FormulaTab. # noqa: E501
validation_message
Gets the validation_message of this FormulaTab. # noqa: E501
The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501
Returns
The validation_message of this FormulaTab. # noqa: E501
validation_message_metadata
Gets the validation_message_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the validationMessage property is editable. # noqa: E501
Returns
The validation_message_metadata of this FormulaTab. # noqa: E501
validation_pattern
Gets the validation_pattern of this FormulaTab. # noqa: E501
A regular expression used to validate input for the tab. # noqa: E501
Returns
The validation_pattern of this FormulaTab. # noqa: E501
validation_pattern_metadata
Gets the validation_pattern_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the validationPattern property is editable. # noqa: E501
Returns
The validation_pattern_metadata of this FormulaTab. # noqa: E501
value
Gets the value of this FormulaTab. # noqa: E501
Specifies the value of the tab. # noqa: E501
Returns
The value of this FormulaTab. # noqa: E501
value_metadata
Gets the value_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the value property is editable. # noqa: E501
Returns
The value_metadata of this FormulaTab. # noqa: E501
warning_details
Gets the warning_details of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The warning_details of this FormulaTab. # noqa: E501
width
Gets the width of this FormulaTab. # noqa: E501
Width of the tab in pixels. # noqa: E501
Returns
The width of this FormulaTab. # noqa: E501
width_metadata
Gets the width_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the width property is editable. # noqa: E501
Returns
The width_metadata of this FormulaTab. # noqa: E501
x_position
Gets the x_position of this FormulaTab. # noqa: E501
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501
Returns
The x_position of this FormulaTab. # noqa: E501
x_position_metadata
Gets the x_position_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the xPosition property is editable. # noqa: E501
Returns
The x_position_metadata of this FormulaTab. # noqa: E501
y_position
Gets the y_position of this FormulaTab. # noqa: E501
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501
Returns
The y_position of this FormulaTab. # noqa: E501
y_position_metadata
Gets the y_position_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the yPosition property is editable. # noqa: E501
Returns
The y_position_metadata of this FormulaTab. # noqa: E501
def
to_dict(self)
3588 def to_dict(self): 3589 """Returns the model properties as a dict""" 3590 result = {} 3591 3592 for attr, _ in six.iteritems(self.swagger_types): 3593 value = getattr(self, attr) 3594 if isinstance(value, list): 3595 result[attr] = list(map( 3596 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3597 value 3598 )) 3599 elif hasattr(value, "to_dict"): 3600 result[attr] = value.to_dict() 3601 elif isinstance(value, dict): 3602 result[attr] = dict(map( 3603 lambda item: (item[0], item[1].to_dict()) 3604 if hasattr(item[1], "to_dict") else item, 3605 value.items() 3606 )) 3607 else: 3608 result[attr] = value 3609 if issubclass(FormulaTab, dict): 3610 for key, value in self.items(): 3611 result[key] = value 3612 3613 return result
Returns the model properties as a dict