Struct DocApiContentControls 

pub struct DocApiContentControls<'a, I: Invoker> { /* private fields */ }

Implementations

impl<'a, I: Invoker> DocApiContentControls<'a, I>

pub fn new(invoker: &'a I) -> Self

pub fn checkbox(&self) -> DocApiContentControlsCheckbox<'a, I>

pub fn choice_list(&self) -> DocApiContentControlsChoiceList<'a, I>

pub fn date(&self) -> DocApiContentControlsDate<'a, I>

pub fn group(&self) -> DocApiContentControlsGroup<'a, I>

pub fn repeating_section(&self) -> DocApiContentControlsRepeatingSection<'a, I>

pub fn text(&self) -> DocApiContentControlsText<'a, I>

pub fn append_content<'call>( &'call self, params: &'call DocContentControlsAppendContentBoundParams, ) -> impl Future<Output = Result<DocContentControlsAppendContentResult>> + Send + 'call

Append content to the end of a content control.

pub async fn append_content_with_options( &self, params: &DocContentControlsAppendContentBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsAppendContentResult>

Append content to the end of a content control.

pub fn clear_binding<'call>( &'call self, params: &'call DocContentControlsClearBindingBoundParams, ) -> impl Future<Output = Result<DocContentControlsClearBindingResult>> + Send + 'call

Remove data binding metadata from a content control.

pub async fn clear_binding_with_options( &self, params: &DocContentControlsClearBindingBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsClearBindingResult>

Remove data binding metadata from a content control.

pub fn clear_content<'call>( &'call self, params: &'call DocContentControlsClearContentBoundParams, ) -> impl Future<Output = Result<DocContentControlsClearContentResult>> + Send + 'call

Clear all content inside a content control, leaving it empty.

pub async fn clear_content_with_options( &self, params: &DocContentControlsClearContentBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsClearContentResult>

Clear all content inside a content control, leaving it empty.

pub fn copy<'call>( &'call self, params: &'call DocContentControlsCopyBoundParams, ) -> impl Future<Output = Result<DocContentControlsCopyResult>> + Send + 'call

Copy a content control to a destination position. Copied SDTs receive new IDs.

pub async fn copy_with_options( &self, params: &DocContentControlsCopyBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsCopyResult>

Copy a content control to a destination position. Copied SDTs receive new IDs.

pub fn delete<'call>( &'call self, params: &'call DocContentControlsDeleteBoundParams, ) -> impl Future<Output = Result<DocContentControlsDeleteResult>> + Send + 'call

Delete a content control and its content. Set overrideDeletionLock to remove a deletion-locked target without first unlocking it.

pub async fn delete_with_options( &self, params: &DocContentControlsDeleteBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsDeleteResult>

Delete a content control and its content. Set overrideDeletionLock to remove a deletion-locked target without first unlocking it.

pub fn get<'call>( &'call self, params: &'call DocContentControlsGetBoundParams, ) -> impl Future<Output = Result<DocContentControlsGetResult>> + Send + 'call

Retrieve a single content control by target.

pub async fn get_with_options( &self, params: &DocContentControlsGetBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsGetResult>

Retrieve a single content control by target.

pub fn get_binding<'call>( &'call self, params: &'call DocContentControlsGetBindingBoundParams, ) -> impl Future<Output = Result<DocContentControlsGetBindingResult>> + Send + 'call

Get the data binding metadata (w:dataBinding) of a content control.

pub async fn get_binding_with_options( &self, params: &DocContentControlsGetBindingBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsGetBindingResult>

Get the data binding metadata (w:dataBinding) of a content control.

pub fn get_content<'call>( &'call self, params: &'call DocContentControlsGetContentBoundParams, ) -> impl Future<Output = Result<DocContentControlsGetContentResult>> + Send + 'call

Get the text content of a content control.

pub async fn get_content_with_options( &self, params: &DocContentControlsGetContentBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsGetContentResult>

Get the text content of a content control.

pub fn get_parent<'call>( &'call self, params: &'call DocContentControlsGetParentBoundParams, ) -> impl Future<Output = Result<DocContentControlsGetParentResult>> + Send + 'call

Get the parent content control of the target, if any.

pub async fn get_parent_with_options( &self, params: &DocContentControlsGetParentBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsGetParentResult>

Get the parent content control of the target, if any.

pub fn get_raw_properties<'call>( &'call self, params: &'call DocContentControlsGetRawPropertiesBoundParams, ) -> impl Future<Output = Result<DocContentControlsGetRawPropertiesResult>> + Send + 'call

Get the raw sdtPr properties of a content control as a passthrough hash.

pub async fn get_raw_properties_with_options( &self, params: &DocContentControlsGetRawPropertiesBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsGetRawPropertiesResult>

Get the raw sdtPr properties of a content control as a passthrough hash.

pub fn insert_after<'call>( &'call self, params: &'call DocContentControlsInsertAfterBoundParams, ) -> impl Future<Output = Result<DocContentControlsInsertAfterResult>> + Send + 'call

Insert content immediately after a content control.

pub async fn insert_after_with_options( &self, params: &DocContentControlsInsertAfterBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsInsertAfterResult>

Insert content immediately after a content control.

pub fn insert_before<'call>( &'call self, params: &'call DocContentControlsInsertBeforeBoundParams, ) -> impl Future<Output = Result<DocContentControlsInsertBeforeResult>> + Send + 'call

Insert content immediately before a content control.

pub async fn insert_before_with_options( &self, params: &DocContentControlsInsertBeforeBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsInsertBeforeResult>

Insert content immediately before a content control.

pub fn list<'call>( &'call self, params: &'call DocContentControlsListBoundParams, ) -> impl Future<Output = Result<DocContentControlsListResult>> + Send + 'call

List all content controls in the document with optional type/tag filtering.

pub async fn list_with_options( &self, params: &DocContentControlsListBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsListResult>

List all content controls in the document with optional type/tag filtering.

pub fn list_children<'call>( &'call self, params: &'call DocContentControlsListChildrenBoundParams, ) -> impl Future<Output = Result<DocContentControlsListChildrenResult>> + Send + 'call

List direct child content controls nested inside the target.

pub async fn list_children_with_options( &self, params: &DocContentControlsListChildrenBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsListChildrenResult>

List direct child content controls nested inside the target.

pub fn list_in_range<'call>( &'call self, params: &'call DocContentControlsListInRangeBoundParams, ) -> impl Future<Output = Result<DocContentControlsListInRangeResult>> + Send + 'call

List content controls within a block range.

pub async fn list_in_range_with_options( &self, params: &DocContentControlsListInRangeBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsListInRangeResult>

List content controls within a block range.

pub fn move_<'call>( &'call self, params: &'call DocContentControlsMoveBoundParams, ) -> impl Future<Output = Result<DocContentControlsMoveResult>> + Send + 'call

Move a content control to a new position: before or after another SDT, to the document start or end, or to an arbitrary caret inside a paragraph (the inParagraph destination) for drag-and-drop. Direct moves preserve the original ID; tracked-mode authoring supports safe top-level block SDTs (SDT-to-SDT destinations only) and remaps the destination SDT ID to avoid duplicate live anchors.

pub async fn move_with_options( &self, params: &DocContentControlsMoveBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsMoveResult>

Move a content control to a new position: before or after another SDT, to the document start or end, or to an arbitrary caret inside a paragraph (the inParagraph destination) for drag-and-drop. Direct moves preserve the original ID; tracked-mode authoring supports safe top-level block SDTs (SDT-to-SDT destinations only) and remaps the destination SDT ID to avoid duplicate live anchors.

pub fn normalize_tag_payload<'call>( &'call self, params: &'call DocContentControlsNormalizeTagPayloadBoundParams, ) -> impl Future<Output = Result<DocContentControlsNormalizeTagPayloadResult>> + Send + 'call

Normalize a content control tag between plain-string and JSON-encoded formats.

pub async fn normalize_tag_payload_with_options( &self, params: &DocContentControlsNormalizeTagPayloadBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsNormalizeTagPayloadResult>

Normalize a content control tag between plain-string and JSON-encoded formats.

pub fn normalize_word_compatibility<'call>( &'call self, params: &'call DocContentControlsNormalizeWordCompatibilityBoundParams, ) -> impl Future<Output = Result<DocContentControlsNormalizeWordCompatibilityResult>> + Send + 'call

Normalize a content control to resolve Word compatibility issues.

pub async fn normalize_word_compatibility_with_options( &self, params: &DocContentControlsNormalizeWordCompatibilityBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsNormalizeWordCompatibilityResult>

Normalize a content control to resolve Word compatibility issues.

pub fn patch<'call>( &'call self, params: &'call DocContentControlsPatchBoundParams, ) -> impl Future<Output = Result<DocContentControlsPatchResult>> + Send + 'call

Patch metadata properties on a content control (tag, alias, appearance, color, etc.). V2 does not support placeholder or showingPlaceholder; defining either field rejects the entire patch without changing properties or content.

pub async fn patch_with_options( &self, params: &DocContentControlsPatchBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsPatchResult>

Patch metadata properties on a content control (tag, alias, appearance, color, etc.). V2 does not support placeholder or showingPlaceholder; defining either field rejects the entire patch without changing properties or content.

pub fn patch_raw_properties<'call>( &'call self, params: &'call DocContentControlsPatchRawPropertiesBoundParams, ) -> impl Future<Output = Result<DocContentControlsPatchRawPropertiesResult>> + Send + 'call

Apply raw XML-level patches to the sdtPr subtree of a content control.

pub async fn patch_raw_properties_with_options( &self, params: &DocContentControlsPatchRawPropertiesBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsPatchRawPropertiesResult>

Apply raw XML-level patches to the sdtPr subtree of a content control.

pub fn prepend_content<'call>( &'call self, params: &'call DocContentControlsPrependContentBoundParams, ) -> impl Future<Output = Result<DocContentControlsPrependContentResult>> + Send + 'call

Prepend content to the beginning of a content control.

pub async fn prepend_content_with_options( &self, params: &DocContentControlsPrependContentBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsPrependContentResult>

Prepend content to the beginning of a content control.

pub fn replace_content<'call>( &'call self, params: &'call DocContentControlsReplaceContentBoundParams, ) -> impl Future<Output = Result<DocContentControlsReplaceContentResult>> + Send + 'call

Replace the entire content of a content control. For direct V2 edits, overrideContentLock replaces locked content in one history entry while preserving the target lock and identity.

pub async fn replace_content_with_options( &self, params: &DocContentControlsReplaceContentBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsReplaceContentResult>

Replace the entire content of a content control. For direct V2 edits, overrideContentLock replaces locked content in one history entry while preserving the target lock and identity.

pub fn select_by_tag<'call>( &'call self, params: &'call DocContentControlsSelectByTagBoundParams, ) -> impl Future<Output = Result<DocContentControlsSelectByTagResult>> + Send + 'call

Select content controls matching a specific tag value.

pub async fn select_by_tag_with_options( &self, params: &DocContentControlsSelectByTagBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsSelectByTagResult>

Select content controls matching a specific tag value.

pub fn select_by_title<'call>( &'call self, params: &'call DocContentControlsSelectByTitleBoundParams, ) -> impl Future<Output = Result<DocContentControlsSelectByTitleResult>> + Send + 'call

Select content controls matching a specific title (alias) value.

pub async fn select_by_title_with_options( &self, params: &DocContentControlsSelectByTitleBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsSelectByTitleResult>

Select content controls matching a specific title (alias) value.

pub fn set_binding<'call>( &'call self, params: &'call DocContentControlsSetBindingBoundParams, ) -> impl Future<Output = Result<DocContentControlsSetBindingResult>> + Send + 'call

Set data binding metadata on a content control.

pub async fn set_binding_with_options( &self, params: &DocContentControlsSetBindingBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsSetBindingResult>

Set data binding metadata on a content control.

pub fn set_lock_mode<'call>( &'call self, params: &'call DocContentControlsSetLockModeBoundParams, ) -> impl Future<Output = Result<DocContentControlsSetLockModeResult>> + Send + 'call

Set the lock mode on a content control. In non-collaborative V2 sessions, addToHistory: false excludes this lock change while retaining the lock across Undo/Redo.

pub async fn set_lock_mode_with_options( &self, params: &DocContentControlsSetLockModeBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsSetLockModeResult>

Set the lock mode on a content control. In non-collaborative V2 sessions, addToHistory: false excludes this lock change while retaining the lock across Undo/Redo.

pub fn set_type<'call>( &'call self, params: &'call DocContentControlsSetTypeBoundParams, ) -> impl Future<Output = Result<DocContentControlsSetTypeResult>> + Send + 'call

Transition a content control to a different semantic type. Metadata-only; no implicit content rewrite.

pub async fn set_type_with_options( &self, params: &DocContentControlsSetTypeBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsSetTypeResult>

Transition a content control to a different semantic type. Metadata-only; no implicit content rewrite.

pub fn unwrap<'call>( &'call self, params: &'call DocContentControlsUnwrapBoundParams, ) -> impl Future<Output = Result<DocContentControlsUnwrapResult>> + Send + 'call

Remove the content control wrapper, preserving its content in place.

pub async fn unwrap_with_options( &self, params: &DocContentControlsUnwrapBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsUnwrapResult>

Remove the content control wrapper, preserving its content in place.

pub fn validate_word_compatibility<'call>( &'call self, params: &'call DocContentControlsValidateWordCompatibilityBoundParams, ) -> impl Future<Output = Result<DocContentControlsValidateWordCompatibilityResult>> + Send + 'call

Validate a content control for Word compatibility issues.

pub async fn validate_word_compatibility_with_options( &self, params: &DocContentControlsValidateWordCompatibilityBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsValidateWordCompatibilityResult>

Validate a content control for Word compatibility issues.

pub fn wrap<'call>( &'call self, params: &'call DocContentControlsWrapBoundParams, ) -> impl Future<Output = Result<DocContentControlsWrapResult>> + Send + 'call

Wrap existing content with a new content control.

pub async fn wrap_with_options( &self, params: &DocContentControlsWrapBoundParams, options: InvokeOptions, ) -> Result<DocContentControlsWrapResult>

Wrap existing content with a new content control.