Skip to content

development to master #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Aug 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
5d4e72d
Merge pull request #233 from Syncfusion-Content/hotfix/hotfix-v30.1.37
SyncfusionBuild Jun 26, 2025
ad7a0b6
Merge pull request #235 from syncfusion-content/Docx-view-support
kalirajanganeshan Jul 7, 2025
9e445ba
Merge pull request #236 from syncfusion-content/Docx-view-support
kalirajanganeshan Jul 7, 2025
f14389e
Merge pull request #237 from syncfusion-content/Docx-view-support
kalirajanganeshan Jul 7, 2025
e451610
Merge pull request #238 from syncfusion-content/Docx-view-support
kalirajanganeshan Jul 8, 2025
54fc4f0
Update overview.md
kalirajanganeshan Jul 8, 2025
5ca0784
Merge pull request #241 from Syncfusion-Content/hotfix/hotfix-v30.1.37
SyncfusionBuild Jul 9, 2025
0baa583
Merge pull request #243 from syncfusion-content/Pdf-view-support
kalirajanganeshan Jul 20, 2025
82b4f3e
Merge pull request #244 from syncfusion-content/Pdf-view-support
kalirajanganeshan Jul 21, 2025
5699ffc
Merge pull request #245 from syncfusion-content/Pdf-view-support
kalirajanganeshan Jul 21, 2025
ec7eb4f
Merge pull request #249 from Syncfusion-Content/hotfix/hotfix-v30.1.37
SyncfusionBuild Jul 23, 2025
d10de4e
Merge pull request #251 from syncfusion-content/Md-Support
DeepakRajSundar Aug 4, 2025
b7353a0
New image and Faq re arrange
VinothKumar-Ganesan Aug 5, 2025
5a7423a
Merge pull request #253 from syncfusion-content/Md-Support
kalirajanganeshan Aug 5, 2025
beffd47
Merge pull request #255 from syncfusion-content/Md-Support
kalirajanganeshan Aug 5, 2025
a5bb454
Merge pull request #257 from Syncfusion-Content/hotfix/hotfix-v30.1.37
SyncfusionBuild Aug 5, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 40 additions & 41 deletions Extension/Document-Viewer-Extension/Visual-Studio-Code/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,29 +23,16 @@ To install the Document Viewer extension:
- Restart VS Code if prompted.
- The extension will automatically handle supported file types (.docx, .xlsx, .pdf, .csv, .tsv, .md).

### Can I edit files in the Document Viewer?

Yes, the Document Viewer allows basic editing of Word, Excel, Markdown, CSV, and TSV files directly within VS Code. This extension focuses on essential<sup style="font-size:70%">&reg;</sup> editing tasks to streamline your workflow. For advanced features such as applying formulas, formatting, and complex spreadsheet functions, we recommend using the [Syncfusion® Spreadsheet component](https://www.syncfusion.com/javascript-ui-controls/js-spreadsheet).

### Is the Document Viewer suitable for large datasets?

Yes, the extension's sorting and filtering tools are designed to help you organize and analyze large datasets efficiently.

### Can I customize the document viewer features?

Yes, you can customize the Document Viewer’s features. Options such as read-only mode, sorting, and filtering can be managed directly from the status bar or through VS Code settings. Editing is supported for all file types included except PDF, and sorting and filtering features are specifically available for spreadsheet formats like Excel, CSV, and TSV files.

### Is there a way to ensure data integrity while reviewing files?

Yes, by using the Read-Only Mode, you can ensure that data remains unchanged while reviewing sensitive or critical files.

### How do I view Microsoft Word documents in VS Code?

You can view Microsoft Word documents (.docx) directly in VS Code using the Syncfusion Document Viewer extension. Simply install the extension from the VS Code marketplace, then open any .docx file in your workspace. The extension provides a built-in viewer that renders Word documents with formatting preserved, allowing you to read and perform basic editing operations without leaving your development environment.

### Can I edit Word files in VS Code with this extension?
### Can I view PDF files in VS Code?

Yes, the Document Viewer extension supports minimal editing of Microsoft Word documents. While it's primarily designed for viewing, you can perform basic text modifications and content updates. However, for advanced formatting and complex editing tasks, you may still need to use Microsoft Word for full functionality.
Yes, you can view PDF files directly in Visual Studio using the Document Viewer extension:
- Install the Document Viewer extension from the VS Code Marketplace.
- Open a .pdf file in your workspace.
- The extension will render the PDF within VS Code, allowing you to view the document with preserved formatting. You can navigate pages, zoom in/out, and search text within the PDF.

### How to view and edit Excel files (.xlsx) in VS Code?

Expand All @@ -56,6 +43,10 @@ The Document Viewer extension allows you to view and edit Excel files (.xlsx) di
- Perform basic spreadsheet operations, such as filtering and sorting
- Configure read-only mode if you only need viewing capabilities

### How do I view Markdown files in VS Code?

You can view Markdown (.md) files directly in VS Code using the Document Viewer extension. Simply install the extension from the VS Code marketplace and open any .md file in your workspace. The extension provides a built-in viewer that renders markdown files with formatting, allowing you to read and perform basic editing operations without leaving your development environment.

### How do I view CSV and TSV files with proper column alignment in VS Code?

The extension provides enhanced viewing for CSV and TSV files with proper column alignment and formatting. Features include:
Expand All @@ -65,17 +56,29 @@ The extension provides enhanced viewing for CSV and TSV files with proper column
- Large file handling: Efficiently handles large CSV/TSV files without performance issues
- Customizable display: Configure column widths and viewing preferences

### Does the Document Viewer support other file formats like Word or PDF?
### Can I edit files in the Document Viewer?

Yes, it supports PDF, Word, Markdown, Excel, CSV, and TSV files.
Yes, the Document Viewer allows basic editing of Word, Excel, Markdown, CSV, and TSV files directly within VS Code. This extension focuses on essential<sup style="font-size:70%">&reg;</sup> editing tasks to streamline your workflow. For advanced features such as applying formulas, formatting, and complex spreadsheet functions, we recommend using the [Syncfusion® Spreadsheet component](https://www.syncfusion.com/javascript-ui-controls/js-spreadsheet).

### Can I view PDF files in VS Code?
### Can I edit Word files in VS Code with this extension?

Yes, you can view PDF files directly in Visual Studio using the Document Viewer extension:
- Install the Document Viewer extension from the VS Code Marketplace.
- Open a .pdf file in your workspace.
- The extension will render the PDF within VS Code, allowing you to view the document with preserved formatting. You can navigate pages, zoom in/out, and search text within the PDF.
Yes, the Document Viewer extension supports minimal editing of Microsoft Word documents. While it's primarily designed for viewing, you can perform basic text modifications and content updates. However, for advanced formatting and complex editing tasks, you may still need to use Microsoft Word for full functionality.

### Is the Document Viewer suitable for large datasets?

Yes, the extension's sorting and filtering tools are designed to help you organize and analyze large datasets efficiently.

### Can I customize the document viewer features?

Yes, you can customize the Document Viewer’s features. Options such as read-only mode, sorting, and filtering can be managed directly from the status bar or through VS Code settings. Editing is supported for all file types included except PDF, and sorting and filtering features are specifically available for spreadsheet formats like Excel, CSV, and TSV files.

### Is there a way to ensure data integrity while reviewing files?

Yes, by using the Read-Only Mode, you can ensure that data remains unchanged while reviewing sensitive or critical files.

### Does the Document Viewer support other file formats like Word or PDF?

Yes, it supports PDF, Word, Markdown, Excel, CSV, and TSV files.

### What file formats are supported by the Document Viewer extension?

Expand All @@ -88,19 +91,15 @@ Supported formats include:

### Does the Document Viewer support Markdown files in VS Code?

Yes, as of the latest version, the Document Viewer extension does support Markdown (.md) files in Visual Studio Code. In addition to Markdown, it allows viewing and light editing of Microsoft Office documents (Word, Excel), PDFs, CSV, and TSV files directly within the VS Code editor.

### Does the Document Viewer Extension upload or transfer my files to a remote server before rendering them in VS Code?

No. The extension uses Syncfusion’s pure-JavaScript Document Editor, Spreadsheet, PDF Viewer, and Markdown editor components to parse and render your files entirely on the client. Your document data never leaves your machine, and no internet connection or server-side processing is required.
Yes, the Document Viewer extension does support Markdown (.md) files in Visual Studio Code. In addition to Markdown, it allows viewing and light editing of Microsoft Office documents (Word, Excel), PDFs, CSV, and TSV files directly within the VS Code editor.

### Does viewing PDF files in Document Viewer Extension requires any external dependencies?

No. The extension uses Syncfusion's standalone PDF viewer component, ensuring seamless setup and consistent PDF rendering directly within the VS Code.

### How do I view Markdown files in VS Code?
### Does the Document Viewer Extension upload or transfer my files to a remote server before rendering them in VS Code?

You can view Markdown (.md) files directly in VS Code using the Document Viewer extension. Simply install the extension from the VS Code marketplace and open any .md file in your workspace. The extension provides a built-in viewer that renders markdown files with formatting, allowing you to read and perform basic editing operations without leaving your development environment.
No. The extension uses Syncfusion’s pure-JavaScript Document Editor, Spreadsheet, PDF Viewer, and Markdown editor components to parse and render your files entirely on the client. Your document data never leaves your machine, and no internet connection or server-side processing is required.

### How does the Document Viewer compare to other VS Code document extensions?

Expand All @@ -111,15 +110,6 @@ The Document Viewer stands out with:
- Active development: Regular updates and planned feature additions
- Enterprise-grade: Built by Syncfusion, known for professional development tools

### Are there any limitations I should know about?

Current limitations include:
- Markdown Editing: Adding images currently requires a valid image URL, as support for adding file paths is not provided.
- Advanced editing: Limited to basic modifications compared to native Office applications
- File size: Very large documents may have performance considerations
- Complex formatting: Some advanced Word/Excel features may not render perfectly
- Collaboration: Real-time collaboration features are not available

### How do I troubleshoot common issues with the Document Viewer extension?

Common solutions include:
Expand All @@ -129,6 +119,15 @@ Common solutions include:
- Clear cache: Reload the window (Ctrl+Shift+P → "Reload Window")
- Compatibility: Ensure your VS Code version is compatible with the extension

### Are there any limitations I should know about?

Current limitations include:
- Markdown Editing: Adding images currently requires a valid image URL, as support for adding file paths is not provided.
- Advanced editing: Limited to basic modifications compared to native Office applications
- File size: Very large documents may have performance considerations
- Complex formatting: Some advanced Word/Excel features may not render perfectly
- Collaboration: Real-time collaboration features are not available

### How can I provide feedback or ask questions about the extension?

We would love to hear from you! Please contact us through our [Syncfusion® Feedback Portal](https://www.syncfusion.com/feedback/extension).
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before getting started, make sure your environment meets the following requireme
> The minimum version of the Visual Studio Code is 1.73.0 to use the Document Viewer Extension.


## Install through the Visual Studio Code Extensions
## Install through the Visual Studio Code

The following steps explain how to install the Document Viewer extensions from Visual Studio Code Extensions.

Expand All @@ -47,4 +47,18 @@ The following steps explain how to download Document Viewer extension from the V

3. Click the Install button in the **"Document Viewer"** extension.

4. After the installation, restart Visual Studio Code when suggested.
4. After the installation, restart Visual Studio Code when suggested.

## Install Document Viewer from Visual Studio code Command Palette

To install the Document Viewer extension in Visual Studio Code:

1. Open Visual Studio Code.

2. Press **Ctrl + P** to open the command palette.

3. Type and execute the following command:

```
ext install SyncfusionInc.Document-Viewer-VSCode-Extensions
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ documentation: ug

## Overview

The **Document Viewer** extension for Visual Studio Code simplifies data handling by integrating essential features directly into the coding environment. It allows users to view Word, Excel, PDF, Markdown, CSV, and TSV files and provides editing and management features for all supported formats apart from PDF directly within Visual Studio Code without any additional tools.
The **Document Viewer** extension enables developers to seamlessly view Word, Excel, Pdf, Markdown, CSV, and TSV files directly within VS Code. No more switching between applications - keep your workflow uninterrupted by viewing documents in the same environment where you code.

## Key Features

- **Effortless Viewing**: Seamlessly open and view Word (`.docx`, `.dotx`, `.docm`, `.dot`, `.doc`, `.rtf`), Excel (`.xlsx`, `.xls`, `.xlsm`, `.xltx`, `.xltm`, `.xlsb`, `.xlt`), PDF (`.pdf`), Markdown(`.md`), CSV (`.csv`), and TSV (`.tsv`) files.
- **Effortless Viewing**: Seamlessly open and view Word (`.docx`, `.dotx`, `.docm`, `.dot`, `.doc`, `.rtf`), Excel (`.xlsx`, `.xls`, `.xlsm`, `.xltx`, `.xltm`, `.xlsb`, `.xlt`), PDF (`.pdf`), Markdown (`.md`), CSV (`.csv`), and TSV (`.tsv`) files.

- **Edit**: Edit, and save Word, Excel, Markdown, CSV, and TSV files.

- **Read-Only Mode**: Protect data from accidental modifications.

- **Sorting and Filtering**: Organize data efficiently using filter options in column headers for spreadsheet files.
- **Sorting and Filtering**: Organize data efficiently using sorting and filtering options in column headers for spreadsheet files.
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,7 @@ The **Document Viewer** extension for Visual Studio Code enables developers to s

## Document Viewer 4.0.0

The **Document Viewer** 4.0.0 for Visual Studio Code now empowers seamless support for viewing and editing Markdown(`.md`) files while extending its versatility through enhanced compatibility with Excel file formats, including `.xlsm`, `.xltx`, `.xltm`, `.xlsb`, `.xlt`.

### Features

- **View and Edit Files**: Open and edit Markdown and included Excel format files within Vs code environment.
- **Read-Only Mode**: Enable read-only mode to secure your content and eliminate the risk of unintended edits.
- **Sorting and Filtering**:Instantly organize and explore your spreadsheet data using intuitive sorting and filtering options available in column header.
The **Document Viewer** 4.0.0 for Visual Studio Code now empowers seamless support for viewing and editing Markdown (`.md`) files while extending its versatility through enhanced compatibility with Excel file formats, including `.xlsm`, `.xltx`, `.xltm`, `.xlsb`, `.xlt`.

---

Expand Down