Method write_string

xlsxwriter/worksheet.py:577–595

Write a string to a worksheet cell. Args: row: The cell row (zero indexed). col: The cell column (zero indexed). string: Cell data. Str. format: An optional cell Format object. Returns: 0: Success.

(
        self, row: int, col: int, string: str, cell_format: Optional[Format] = None
    )

    @convert_cell_args
    def write_string(
        self, row: int, col: int, string: str, cell_format: Optional[Format] = None
    ) -> Literal[0, -1, -2]:
        """
        Write a string to a worksheet cell.

        Args:
            row:    The cell row (zero indexed).
            col:    The cell column (zero indexed).
            string: Cell data. Str.
            format: An optional cell Format object.

        Returns:
            0:  Success.
            -1: Row or column is out of worksheet bounds.
            -2: String truncated to 32k characters.

        """
        return self._write_string(row, col, string, cell_format)

    # Undecorated version of write_string().
    def _write_string(