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