Persistent Custom XML #45
Comments
|
This is a very good issue! Looking forward to PR for this. |
|
Going to work on this now |
|
@algomaster99 Also, I had some difficulties setting this up in the code. |
|
I would try the following approaches:
I agree the best approach would have been what you mentioned but as far as I recollect these preview APIs don't work even in the development environment. Anyway, they have suggested to not use it for now so let's keep it that way. |
@algomaster99 |
|
@algomaster99
In this way, we can ensure users delete from one place only and insert from one place only thereby providing some safety. The deletable thing can also be switched with if(template)render delete_template;
else render add_to_templateMAJOR DRAWBACK: If a user types anything other than the template and then deletes any template, the typed thing will vanish. Since the debugger is not working, I am not able to debug my approach. As a result, I have posted it here to get some feedback on whether we should proceed with this or not? |
Not sure what you mean by this. I am assuming you want to render the templates using the React state when document reopens, right? If that is the case, it is not the best way to go through because you will have to update the state first using CustomXMLPart. Better to directly use the latter to do so.
For now, let's keeping inserting from library component only.
I think unlike because the you are supposed to delete 3 things only - content control, the content inside, and the XML node in CustomXMLPart. Anything outside the content control should be unaffected.
Do you mean the devtools is not working? Yes, the approach sounds good. Proceed by creating a button. Add a JS event listener which will get triggered |
Yes it keeps on crashing and reloading. There's also a thread in slack where the full information regarding this is available
I apologise but I got confused as to follow which approach and which things. 😅 |
That's weird. But I hope you figure out. It is tough to find things related to MS Word add-in development.
Sure.
When you reinitialise the document, make sure you populate the state maintained in your document component using the template identifier stored in CustomXML. |
|
@algomaster99 |
|
No problem. Let me know if you have any more follow up questions about the implementation. |
|
@algomaster99 if (!identifierExists) {
setup(ciceroMark, template);
newXml += `<template xmlns="${templateIdentifier}" />`;
newXml += '</templates>';
Office.context.document.customXmlParts.getByNamespaceAsync(CUSTOM_XML_NAMESPACE, res => {
if (res.status === Office.AsyncResultStatus.Succeeded) {
for (let index=0; index<res.value.length; ++index) {
res.value[index].deleteAsync();
}
}
});
Office.context.document.customXmlParts.addAsync(newXml);
} else {
console.log('XML NOW', newXml);
Office.context.document.customXmlParts.getByNamespaceAsync(CUSTOM_XML_NAMESPACE, res => {
if (res.status === Office.AsyncResultStatus.Succeeded) {
for (let index=0; index<res.value.length; ++index) {
res.value[index].deleteAsync();
}
}
});
Office.context.document.customXmlParts.addAsync(newXml);
toast(
{
title: 'Duplicate template',
description: <p>Template cannot be inserted as it is already present in the document.</p>,
type: 'error',
time: 5000,
animation: 'fly down',
},
);
}This code is the part where we insert more than one template. So from what I Understood if the template to be inserted is not present. Then the Office.context.document.customXmlParts.getByNamespaceAsync(CUSTOM_XML_NAMESPACE, res => {
if (res.status === Office.AsyncResultStatus.Succeeded) {
for (let index=0; index<res.value.length; ++index) {
res.value[index].deleteAsync();
}
}
});
Office.context.document.customXmlParts.addAsync(newXml);Now, if the identifier is already present, then we need to remove the oldXML. Office.context.document.customXmlParts.getByNamespaceAsync(CUSTOM_XML_NAMESPACE, res => {
if (res.status === Office.AsyncResultStatus.Succeeded) {
for (let index=0; index<res.value.length; ++index) {
res.value[index].deleteAsync();
}
}
});
Office.context.document.customXmlParts.addAsync(newXml);As visible, both the conditions when the template is present and when it is not present use the same code. However, in the second case, the custom XML parts are not being added to the document again. I am quite not able to understand the reasoning for this. The removal of the nodes is happening but not the insertion again. testing.zip |
|
@K-Kumar-01 I would appreciate if you could submit a WIP pull request of the implementation. It will be easier for me to debug. |
|
@algomaster99 Yeah sure I will submit a draft PR. I will clean the code a bit and then submit it ASAP. |
|
@algomaster99 |
Bug Report 🐛
Currently, the custom XML namespace when a template is inserted is persistent i.e. it does not change when a template is removed from the document.
Expected Behavior
When we remove a template from the document, the XML of the
templateIdentifierstored in custom XML should also get removed.The XML looks similar to this.
If one deletes the template
acceptance-of-deliverythen this identifier should also get removed.Current Behavior
The identifier remains there and is not deleted.
Possible Solution
We should remove the identifiers whenever a template is deleted.
Steps to Reproduce
After the add-in server is running and the
npm startcommand is entered.WORD XML format.<template xmlnsin the file)Context (Environment)
Desktop
Detailed Description
The change will ensure that only those identifiers are present whose templates are present in the document.
Possible Implementation
According to this, there is a content-control
onDeletedwhich we can use to delete the identifier of the template.Would you like to work on the issue?
Yes
The text was updated successfully, but these errors were encountered: